sebranly/kaleidoscope

Share your unique Kaleidoscope viewing order with the world

Description

Live at https://sebranly.github.io/kaleidoscope/

Development

Setup

• Clone the repository with git clone [email protected]:sebranly/kaleidoscope.git
• Go into the repository (e.g. with cd)
• Make sure you use correct node (node -v) and npm (npm -v) versions
• Run npm ci to install the dependencies

Start

• To run it locally, run npm run start, it has hot reloading
• To run the test suite (no need to run command above), run npm run test

Deploy

• Commit and push your changes to main branch, or create a merge request as a PR from your clone to this project's main branch
• Make sure to have followed the following. If not, create a new PR.
  • increase the WEBSITE_VERSION from src/constants/general.ts file, by following semver
    • MAJOR version when you make incompatible API changes,
    • MINOR version when you add functionality in a backwards compatible manner, and
    • PATCH version when you make backwards compatible bug fixes.
• Confirm that test suite passes with npm run test
• Then run npm run deploy
• Finally create a new release for this version on GitHub Releases page by adding the changelog