You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Oct 18, 2024. It is now read-only.
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)
The text was updated successfully, but these errors were encountered:
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.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)The text was updated successfully, but these errors were encountered: