After cloning the repository, there should be a documented series of steps to follow that the developer can quickly and intuitively follow to start developing the project locally.
Current Behavior
The documentation at the official docs site for API is missing steps that involve ensuring the database is prepared locally.
Possible Solution
Include prerequisites and minimal getting started steps in the README to allow contributors to immediately have an idea of how to get started. They can refer to the official documentation for additional details.
Include .env.example to demonstrate the development configuration needed.
Use docker-compose to manage local instances of PostgresSQL and related services if needed. (Solves the problem of manually building and importing databases via vanilla Docker)
Expected Behavior
After cloning the repository, there should be a documented series of steps to follow that the developer can quickly and intuitively follow to start developing the project locally.
Current Behavior
The documentation at the official docs site for API is missing steps that involve ensuring the database is prepared locally.
Possible Solution
Include prerequisites and minimal getting started steps in the README to allow contributors to immediately have an idea of how to get started. They can refer to the official documentation for additional details.
Include
.env.exampleto demonstrate the development configuration needed.Use
docker-composeto manage local instances of PostgresSQL and related services if needed. (Solves the problem of manually building and importing databases via vanilla Docker)