Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (55 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

82 lines (55 loc) · 1.7 KB

Development

Install dependencies

In order to setup the project, you have to install npm, yarn and node.

$ make install

You can verify yarn is properly installed using

yarn --version

If this fails, please check manual instructions:

Dev Container instructions

This project includes a development container configuration for VS Code. To use it:

  1. Install Visual Studio Code and the Dev Containers extension.
  2. Open the project in VS Code.
  3. When prompted, reopen the project in the dev container.
  4. The container will automatically install dependencies and set up the environment.
  5. Go to the Start local server section.
Linux instructions 
$ sudo apt install nodejs
$ sudo apt install npm
$ npm install yarn
MacOS instructions 
$ brew install node
$ brew install npm
$ npm install -g yarn
Windows instructions 
$ winget install OpenJS.NodeJS
$ npm install -g yarn

Start local server

To start a local development server, run:

$ make start

If everything is properly installed, the command should open a browser window on http://localhost:3000/.

Most changes are reflected live without having to restart the server.

Generate static content for GitHub Pages deployment

To generate static from the project that can be served using any static contents hosting service (like gh-pages).

$ make build