Skip to content

SpeciesFileGroup/taxonworks_api

Repository files navigation

docs

taxonworks_api

Documentation for the TaxonWorks workbench API, served at https://api.taxonworks.org. Application code is here.

Building

Documentation uses RAML, it is built with gulp:

Clone this repository, then:

npm install

npx gulp apidoc

Documentation is in /docs. Open /docs/index.html to view locally, or see running an api console.

Deploying

Merge development into main. Github actions do the rest.

Changelog

See CHANGELOG.md. Note this changelog documents changes in the documentation, not the underlying code.

Contributing

See CONTRIBUTING.md.

License

https://opensource.org/licenses/NCSA.

Code of conduct

Please see CODE_OF_CONDUCT.md.