QLEAP Classical to Quantum Optics JS App

Usage

Prerequisites

• Node.js 16.13.0 (see .node-version)

Setup

$ npm ci to install dependencies

Start the server

$ npm start then you can see the page on http://localhost:1234

Lint

eslint will check your code is good or not and if it's easy to fix, eslint will fix it automatically. before commit, you MUST run this to clean up your change.

$ npm run lint

Build

$ npm run build will build your codes into one js file and minify it and then put it on dist dir. basically you don't need to do this because $ npm start will build your code automatically and then start the server and you can browse it.

Contributing

Steps

1. create new feature branch and then checkout it there.
2. modify code
3. $ npm run lint and fix it
4. commit & push
5. send new "Pull Request" to the master branch
6. someone will review your PR
7. fix until reviewer approve your PR
8. if the PR approved, you can merge it
9. automatically deployed to github-pages

Branching strategy

we use "GitHub flow". see the doc, and also this article might be so useful.