PlaceCal developer handbook
PlaceCal developer handbook

PlaceCal developer handbook

Setup / Coding / Live Testing

Ruby and NodeJS setup
Postgres Docker Setup
Creating a new admin user for local testing

How it works

Database structures
PlaceCal big picture
User permissions
Partners and Neighbourhoods
Addresses and Neighbourhoods

Deprecated and currently unsupported code


Creating a new PlaceCal Site
Adding a new PlaceCal developer
Rake Usage
Running rake tasks on the server
Procedure For Dealing With Dataset Errors / Errors In Production

Contribution guidelines


  • e tasks are ones we know how to do and it’s one or a few lines of code. If it doesn’t seem obvious how to do this, ask someone for help. It could be a sign you are overthinking the task or going out of scope.
  • ee tasks are ones we know how to do but we also know they’ll not trivial. If it’s taking more than half a day to get a PR up, then we might need to break down the task more.
  • eee tasks are either totally new ground for us, something we know to be very complicated or a bug we have no idea about. They are expected to take more than a day and should be broken down before commencing work. They should also have an implementation plan that is sanity checked by at least one other developer.