plandev-gateway

The API gateway for PlanDev.

Aerie -> PlanDev Rebrand

This product was formerly known as Aerie and is now named PlanDev. While we've updated most documentation and external references, some legacy mentions of the old product name may remain as we complete the transition.

What to know:

• The planning product, including modeling, simulation, scheduling and constraint-checking, is now named PlanDev
• The sequencing product, including the sequence editor, workspaces, and actions, is now named SeqDev
• All features and functionality remain the same
• Currently, repository names, package names and other internal code references will retain their existing names, and deployment/migration procedures have not changed
• In a future release, our repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels

For the latest documentation, visit: PlanDev Documentation

Need Help?

• Join us on the NASA-AMMOS Slack (#plandev-users)
• Contact plandev-support@googlegroups.com

Develop

First make sure you have Node.js LTS installed.

If you are doing active local development outside of a container, duplicate the .env.template and rename it to .env. Set the default GATEWAY_DB_USER, GATEWAY_DB_PASSWORD, and HASURA_GRAPHQL_JWT_SECRET environment variables. If your Hasura instance is not hosted on http://localhost:8080, update the value of HASURA_API_URL in the .env as well. Afterwards, run the following:

npm install
npm run dev

This will watch for code changes and rebuild and restart the gateway server automatically.

If you are running PlanDev Gateway within a container (i.e. the docker-compose from the main PlanDev repo), run the following before starting the container:

npm install
npm run build
npm start

License

The scripts and documentation in this project are released under the MIT License.