Skip to content

robin-thomas/phi

Repository files navigation

Phi

Contributing

Developing

The development branch is main. This is the branch that all pull requests should be made against. The changes on the main branch are published to GitHub release regularly.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch:
    git checkout -b MY_BRANCH_NAME
  3. Install the dependencies with:
    npm ci
  4. Start developing and watch for code changes:
    npm run dev
  5. It will open a browser tab at http://localhost:3000/

Building

You can build the project, with:

npm run build

You can then serve the built files from a server, with:

mpm run start

Testing

npm run test

If you would like to see the coverage, you can do

npm run test:coverage

Linting

To check the formatting of your code:

npm run lint

Authors