Quick links:
No special actions needed, just follow the general developer setup instructions.
npm run startnpm run testWe use Storybook to develop and test UI components.
To run the Storybook app locally:
# from the root of the repo
npm run start --workspace=apps/storybookOur storybook is deployed to https://storybook.k8s.bluedot.org.
Traffic to the production site (https://bluedot.org) is routed through the website-proxy app.
Important: When adding a new page, you must also add it to the nginx template in website-proxy.
This app follows a multistage deployment process. For more details, see docker-scripts.
To deploy to staging, simply merge a PR into the master branch.
To deploy to production:
- Create a new GitHub release
- Click "Choose a tag" and enter a new tag in the format
website/vX.Y.Z(e.g.,website/v1.2.3) - Select "Previous tag" and choose the previous release tag (e.g.,
website/v1.2.2) - Click "Generate release notes", and review the notes
- Click "Publish release"
The production release workflow is defined in .github/workflows/website_deploy_production.yaml.
Note: Please use SemVer for version numbering.