Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add ERD to documentation and update README #20

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

BramSuurdje
Copy link
Contributor

This pull request includes updates to the documentation and the addition of an ERD diagram for the project. The most important changes include adding sections for documentation and deployment instructions in the README.md file, and creating an ERD diagram in the documentation/erd.md file.

Documentation updates:

  • README.md: Added sections for documentation and deployment instructions, including steps to deploy the project using Docker Compose.

ERD diagram addition:

  • documentation/erd.md: Created an ERD diagram using Mermaid syntax to illustrate the database schema.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 25, 2024
@JesseNHLStenden JesseNHLStenden merged commit 4e05036 into main Nov 25, 2024
3 checks passed
@JesseNHLStenden JesseNHLStenden deleted the feat-add-erd-diagram branch November 25, 2024 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants