-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
90 changed files
with
2,367 additions
and
1,640 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,3 +5,4 @@ war/ | |
*.class | ||
data/ | ||
ice.iml | ||
*.pem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
ICE | ||
=== | ||
|
||
Inventory of Composable Elements (ICE) is an open source registry | ||
software for biological parts developed by the `Joint | ||
BioEnergy Institute <http://www.jbei.org/>`__. It is a Web application used by laboratories to track and search their | ||
constructs. | ||
|
||
ICE is distributed under the Modified BSD license. See LICENSE.txt and LIBRARY_LICENSES.txt for details. | ||
|
||
You can try out the software at our `Public | ||
Registry <http://public-registry.jbei.org>`__. | ||
|
||
Documentation for ICE Users | ||
------------- | ||
|
||
Read the `Manual <https://jbei.github.io/ice/>`__ for installation and usage instructions. | ||
|
||
|
||
Documentation for ICE developers | ||
-------------------------------- | ||
|
||
Requirements | ||
~~~~~~~~~~~~ | ||
To set up a development environment for ICE you will need to install: | ||
|
||
* `BLAST+ <http://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs&DOC_TYPE=Download>`__ ≥ 2.2.28 | ||
* `Java JDK 7 <http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html>`__ | ||
* `Maven <https://maven.apache.org/download.cgi>`__ ≥ 3.0 | ||
|
||
If you use a Debian-like operating system, the following command will install all the requirements | ||
|
||
:: | ||
|
||
sudo apt-get install ncbi-blast+ default-jdk maven | ||
|
||
|
||
Set Up | ||
~~~~~~ | ||
1. Checkout the code and enter the repository | ||
|
||
:: | ||
|
||
git checkout https://github.com/JBEI/ice.git | ||
cd ice | ||
|
||
2. Since the application requires an SSL certificate, generate one that the Jetty Web server can use this command. When prompted for a password, enter **changeit** | ||
|
||
:: | ||
|
||
keytool -genkey -alias tomcat -keyalg RSA -keystore ./.keystore | ||
|
||
3. Start Jetty | ||
|
||
:: | ||
|
||
mvn jetty:run | ||
|
||
4. Point your browser to https://localhost:8443/ to access the application | ||
|
||
Testing | ||
~~~~~~~ | ||
To run the unit test suite | ||
|
||
:: | ||
|
||
mvn test | ||
|
||
Links | ||
----- | ||
|
||
* `ICE Google Group <http://groups.google.com/group/gd-ice>`__ | ||
* `Releases <https://github.com/JBEI/ice/releases>`__: Download the war file associated with the latest release | ||
* `REST API WADL <https://public-registry.jbei.org/rest/application.wadl>`__ | ||
|
||
Related Projects | ||
---------------- | ||
|
||
`The VectorEditor project <https://github.com/JBEI/vectoreditor/>`__ is | ||
used in ICE to display and edit sequences. It also contains other | ||
modules such as sequence checker. | ||
|
||
|Build Status| | ||
|
||
.. |Build Status| image:: https://travis-ci.org/JBEI/ice.svg?branch=dev | ||
:target: https://travis-ci.org/JBEI/ice |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.