This repo contains a ModelSEED RESTful API. The API wraps the ProbModelSEED and Workspace Services and provides additional methods used in the ModelSEED web app.
node
git clone https://github.com/nconrad/ModelSEED-REST.git
cd ModelSEED-REST
npm install
Note: npm install installs all node module dependencies
node server.js --dev
To make our lives easier, running gulp starts a development server along with a process to
update ./api-documentation.json. The dev server will restart automatically on file change (any .js file). For testing, a token can be placed in the file ./dev-user-token.
gulp
API tests are ran with npm test or gulp test.
npm test
Docstrings in server.js are parsed into JSON using ./docs/parse-docs.js.
The resulting JSON structure ./api-documentation.json is then used to produce
fancy online documentation. See ModelSEED-UI
for the front-end code.
Note: api-documentation.json is automatically rebuilt with gulp.
To manually build it, run:
gulp docs
The server script server.js should be ran with forever.
forever start -l /logs/server.log --pidFile /tmp/a -a server.js
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Neal Conrad [email protected]
Released under the MIT license.