Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 1.1 KB

DEVELOPMENT.md

File metadata and controls

20 lines (14 loc) · 1.1 KB

Development

Follow these steps to get going in local development. If you are having trouble, don't be afraid to ask for help.

Prerequisites

Setup

  1. Follow Github's documentation on setting up Git, forking, and cloning.
  2. Execute npm install to install the development dependencies.
    • Do not use yarn install or pnpm install.
    • Some optional dependencies may fail; you can safely ignore these unless you are trying to build the documentation.
    • If you're sick of seeing the failures, run npm install --ignore-scripts.

PRO TIP: After npm install, run npm start to see a list of commands which can be run with npm start <command> (powered by nps).