CONTRIBUTING.md

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 start

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

Development loader

For development, you shold load from dist:

mappable.import.loaders.unshift(async (pkg) => {
    if (!pkg.startsWith('@mappable-world/mappable-default-ui-theme')) return;

    // Load script from dev server
    await mappable.import.script(`./dist/index.js`);

    return window['@mappable-world/mappable-default-ui-theme'];
});

GitHub actions

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

npm version prerelease --preid=beta --no-git-tag-version
git add --all
git commit -m "New version"
git tag 0.0.1-beta.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:

• APIKEY - To run autotests on the JS API https://mappable.world/docs/js-api/quickstart.html#get-api-key
• NPM_TOKEN - To publish your package to npm