@flamingbear/cmrjs v1.10.4-rc.8
Cumulus Framework
📖 Documentation
- Documentation for the latest released version.
- Documentation for the unreleased work.
More Information
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.
🔨 Development
Installation
This is for installation for Cumulus development. See the Cumulus deployment instructions for instructions on deploying the released Cumulus packages.
Prerequisites
- NVM and node version 8.
- AWS CLI
- BASH
- Docker (only required for testing)
- docker-compose (only required for testing
pip install docker-compose
)
Install the correct node version:
nvm install
nvm use
Install Lerna
We 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
Install Local Dependencies
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
Running the Cumulus APIs locally
Start the API:
$ npm run serve
Or start the distribution API:
$ npm run serve-dist
See the API package documentation for more options.
📝 Tests
Unit Tests
LocalStack
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.
Docker containers
Turn on the docker containers first:
$ npm run start-unit-test-stack
Stop localstack/unit test services:
$ npm run stop-unit-test-stack
Run tests
Run the test commands next
$ export LOCAL_ES_HOST=127.0.0.1
$ export LOCALSTACK_HOST=127.0.0.1
$ npm test
Integration Tests
For more information please read this.
🔦 Code Coverage and Quality
For more information please read this.
📦 Adding New Packages
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
.
Running command in all package folders
$ lerna exec -- rm -rf ./package-lock.json
Cleaning Up all the repos
$ npm run clean
Contribution
Please refer to: https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md for more information.
🛒 Release
To release a new version of cumulus read this.
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago