Getting Started

Looking to contribute to the PolicyEngine front-end app? This guide will walk you through getting setup and ready to contribute.

We welcome contributions from all levels of developer, from experienced developers in the field to students writing entry-level code. All we ask is that you have an understanding of how modern JavaScript frameworks function, preferably React v16.8+.

Prerequisites

To begin with React, you must first set up NodeJS, JavaScript's runtime environment.

If you haven't already, install the Node Version Manager by following the instructions at https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating.

Our package uses Node v19. To enable, in your terminal, run

nvm install 19 && nvm use 19

Installing

We currently ask contributors to contribute from a fork. To do so:

1. Fork the repo

https://github.com/PolicyEngine-app/fork

2. Install dependencies

make install

3. Start a server on localhost to see your changes

make debug

Once you've done this, feel free to move onto our Contributions guide.