Improve the readme experience for folks not on team-friendo
Value
If you are team-friendo can access our secrets the configuration step for both development and production mode is easy and magical but starting from scratch there are lots of services to be setup and added to config files. The readme as it stands is a little convoluted and the hope it to make it more of a step by step guide and document some identified gotchas.
Behavior
GIVEN Someone hoping to deploy their own instance of Signalboost
- WHEN they will be starting from the readme and a virtual server
- THEN they should be able to follow the readme to know what services are needed and how to configure Signalboost with this information for production mode
GIVEN Someone who is hoping to be an contributor to Signalboost but is not a member of team-friendo
- WHEN they will be starting from the readme and their localhost
- THEN they should be able to follow the readme to know what services are needed and how to configure Signalboost with this information for development mode
Implementation Notes
- Likely the change in approach will be to start with a section on establishing services, systems and details needed for each mode, followed by configuration steps for configuring files depending on your mode, and then the specifics of working with each mode (Dev vs Prod).