@gometro/mobility-observatory-visualization-module
v5.13.2
Published
This README would normally document whatever steps are necessary to get your application up and running.
Downloads
79
Readme
README
Start up
Setting up local frontend
yarn install
yarn run storybook
Setting up local backend
Set up the Mobility Observatory Service- https://bitbucket.org/GoMetro/gometro-mobility-observatory-service/src/master/
Start the Mobility Observatory Service- See the service's read me
Using npm link in dependant project
@todo add yarn link instructions
React version inconsistent
@todo add yarn instructions for react linking
Publish
To publish a new version...
npm version {major|minor|patch} -m "{change message here}"
yarn run build:publish
API
Defaults
- The default production API URL is
https://api.gometroapp.com
- The default development API URL is
http://localhost:8080
Overrides
If you want to use the API on a development machine or a custom domain set the below...
window.__MOBILITY_USE_DEV_API__ = true;
window.__MOBILITY_DEV_API__ = "your-custom-url-here"
Publishing an image with CI/CD
Tag image
Firstly, make sure you are on a branch named release/* (for example - release/5.0.0)
Then, run the tag script with the relevant change
./tag.sh minor
See more about semantic versioning here - https://semver.org/
Valid options are: major | minor | patch
Then push both the commit and tag up to the repository
git push
git push --tags
And wait for CI/CD to publish the new npm package :)