Getting Started

To run this project we recommend Linux or MacOS. If using Windows use WSL.

Install Node JS

To run this project you will need Node JS (v16.8 or later). We recommend using nvm

Install Yarn

The package manager of choice for this project is yarn. You can install yarn by following this guide

Install Dependencies

  yarn install

Commands

  # start dev server
  yarn dev

  # build project
  yarn build

  # run linters
  yarn lint

CSS Style

This project uses RSCSS conventions. You can read about it here