Skip to content

PEM-Humboldt/biotablero-backend

Repository files navigation

Biotablero backend

Backend services for BioTablero.

Getting Started

Prerequisites

You'll need nodejs v14.15+ and yarn to run the project.

  • For a better performance run in SO linux.

Install dependencies

After cloning the project, install its dependencies running: yarn install

Setup

Check every service documentation to correctly config them.

Deployment

See instructions in every service.

Note: To run all services at the same time you can run the following command:

yarn workspaces foreach -ipv -j unlimited run start

Documentation

To generate the global documentation run yarn all_docs, it will be located under the /docs folder

Production version of these docs are available here.

If you want to generate only one service documentation run yarn workspace <service_name> run docs, it will be located under the /docs folder for that service.

If you want to generate the documentation for all services, but keep them separated run yarn workspaces foreach run docs, it will be located under the /docs folder in every service.

Contributing

There are no guidelines for contribution currently.

Authors

Gerencia de Información Científica - Dirección de conocimiento - Instituto de Investigación de Recursos Biológicos Alexander von Humboldt - Colombia

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License.