chore: add ERD to documentation and update README #20
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thedocumentation/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.