Skip to content
This repository has been archived by the owner on Oct 18, 2024. It is now read-only.

Improve DX with getting started #150

Open
ap0nia opened this issue May 23, 2024 · 0 comments · May be fixed by #145
Open

Improve DX with getting started #150

ap0nia opened this issue May 23, 2024 · 0 comments · May be fixed by #145
Assignees
Labels
area: tools Related to the API's maintenance tooling type: devops Related to DevOps

Comments

@ap0nia
Copy link
Contributor

ap0nia commented May 23, 2024

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)

@ap0nia ap0nia added area: tools Related to the API's maintenance tooling type: devops Related to DevOps labels May 23, 2024
@ap0nia ap0nia self-assigned this May 23, 2024
@ap0nia ap0nia linked a pull request May 23, 2024 that will close this issue
@ap0nia ap0nia moved this from Backlog to Needs Review in PeterPortal API :: Next May 23, 2024
@ap0nia ap0nia moved this from Needs Review to In Progress in PeterPortal API :: Next May 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: tools Related to the API's maintenance tooling type: devops Related to DevOps
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant