- Documentation for the latest released version.
- Documentation for the unreleased work.
For more information about this project of more about NASA's Earth Observing System Data and Information System (EOSDIS) and its cloud work, please contact Katie Baynes or visit us at https://earthdata.nasa.gov.
This is for installation for Cumulus development. See the Cumulus deployment instructions for instructions on deploying the released Cumulus packages.
- NVM and node version 8.
- AWS CLI
- BASH
- Dock 8000 er (only required for testing)
- docker-compose (only required for testing
pip install docker-compose)
Install the correct node version:
nvm install
nvm useWe use Lerna to manage multiple Cumulus packages in the same repo. You need to install lerna as a global module first:
$ npm install -g lerna
We use npm for local package management
$ npm install
$ npm run bootstrap
Building All packages:
$ npm run build
Build and watch packages:
$ npm run watch
Start localstack:
$ docker-compose up local
Start the API:
$ npm run serve
Or start the distribution API:
$ npm run serve-dist
See the API package documentation for more options.
LocalStack provides local versions of most AWS services for testing.
The LocalStack repository has installation instructions.
Localstack is included in the docker-compose file. You only need to run the docker-compose command in the next section in order to use it with your tests.
Turn on the docker containers first:
$ docker-compose up local
If you prefer to run docker in detached mode (i.e. run containers in the background), run:
$ docker-compose up -d local
Run the test commands next
$ export LOCALSTACK_HOST=localhost
$ npm test
For more information please read this.
For more information please read this.
Create a new folder under packages if it is a common library or create folder under cumulus/tasks if it is a lambda task. cd to the folder and run npm init.
Make sure to name the package as @cumulus/package-name.
$ lerna exec -- rm -rf ./package-lock.json
$ npm run clean
Please refer to: https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md for more information.
To release a new version of cumulus read this.