This is the official web app of the PolicyEngine project.
We recommend that you use the latest Node version 19. To easily manage your node versions, get the Node Version Manager nvm and then do
nvm install 19 && nvm use 19
- Clone the repo
https://github.com/PolicyEngine/policyengine-app.git
- Install dependencies
npm ci
- Start a server on localhost to see your changes
npm start
Now you're ready to start developing!
To test your changes, do
npm test
If you're new to the project, go to Issues and search for good first issues label: "good first issue".
Reach out to @nikhilwoodruff and @MaxGhenis to be added as a collaborator so that you can assign yourself to issues.
Please try to be detailed in your PRs about the changes you made and why you made them. You may find yourself looking back at them for reference in the future, or needing insight about someone else's changes. Save yourself a conversation and write it all in the PR!
Here are some best practices for using Git.
We recommend, but do not yet require, that you add tests for any new features or bug-fixes you add, so we can gradually build up the code coverage. We use Jest and the React Testing Library. You can run your tests locally with npm test and they will be run again in the PR pre-flight.
When you're ready for review, switch the PR from Draft to Ready for review and add a contributor as a reviewer.
Distributed under the AGPL License. See LICENCE for more info.
Thanks to Othneil Drew for his README template.