Home

Last updated: May 4, 2020

• For a summary of completed/incompleted features as of May 4, 2020, see Product Roadmap (Summary).
• For a list of great starting points for development, see Starting Points
• Acknowledgements/Knowledge Owners

Quickstart

• For peoplepower-web, see the README here
• For peoplepower-node, see the README here

Branches

• master: complete version of the web-app
• pp-web-base: basic version of the web-app (does not use Airlock) - note that the same credentials (username, password) that would work for master would not work here, as this version of the web-app expects unhashed passwords

Engineering Documentation

• Troubleshooting
• Documentation on Features // Feature-specific Documentation broken down by Feature
• Project Structure
• Dependencies Documentation (see 2 sections below)
• Bill Generation
• Technical Architecture of peoplepower-web and peoplepower-node
• Routing
• Charts
• Testing

Design Documentation

These are external links to Notion pages

• Figma Guide
• Files (Figma)
• User Testing Feedback (we couldn't get to)
• Design status breakdown by Screen

Dependencies

1. The 'Air Suite'
   • Airtable
   • Airlock
   • Airtable Schema Generator
2. Paypal
3. HighCharts
4. Redux

Notes

• Project News is referred to as Community in the codebase. So the Project News screen is the Community.js component, the css for that is community.css etc.
• The Owner table is poorly and confusingly named. See the tooltip on the Airtable base for more information.
• The app only works on Chrome for now because of an Airlock issue
• The CSS naming conventions is not the best right now, and there might be some intentional or unintentional style collision.
• pp-web-base is intended to be a mirror of master, identical in every way (and functional) except without Airlock. This has been mostly true, but there have been a couple of missing commits here and there. note that the same credentials (username, password) that would work for master would not work here, as this version of the web-app expects unhashed passwords

Useful skills for someone to continue development

Required:

• Familiar with JavaScript
• Familiar with React

Bonus:

• Familiar with Redux (not necessary, as we are using a lot of the Redux APIs)
• Familiar with Airtable (not required, as our documentation aims to cover most of our use cases)