Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

69 lines (46 loc) · 1.39 KB

Contributing

To get started in the .env file, you need to declare APIKEY https://mappable.world/docs/js-api/quickstart.html#get-api-key:

To get started:

nvm use
npm run watch

or so if you didn't create the .env file

APIKEY=%APIKEY% npm start

To check with linter:

npm run lint

For the final build:

npm run build

Examples

NOTE:

For examples we use Carina Nebula image with copyrights from webbtelescope.org

Please run:

  • npm run build # or watch. This command will built this utility
  • npm run examples:build. This will load image and generate tiles
  • npm run examples. This will serve examples

GitHub actions

After you create a new tag, or just push changes to the server, ci will be launched

npm version --no-git-tag-version
git add --all
git commit -m "New version"
git tag 0.0.2
git push --tags origin HEAD:main

or run

npm run bump

CI described here

  • .github/workflows/release.yml - triggered when a new tag is created
  • .github/workflows/tests.yml - triggers on any push to the main branch

For it to work, you need to declare two secrets in the GitHub Action: