Merge pull request #1 from PauloniaAQP/chris/backend-ADR

docs: Adding backend stack ADR and database diagram
PauloniaAQP · Jan 17, 2024 · 0226ef0 · 0226ef0
2 parents 6851452 + ea0341b
commit 0226ef0
Show file tree

Hide file tree

Showing 4 changed files with 1,768 additions and 0 deletions.
diff --git a/docs/database/CHANGELOG.md b/docs/database/CHANGELOG.md
@@ -0,0 +1,3 @@
+# 1.0.0
+
+- Initial structure of the core of the databas.
diff --git a/docs/database/README.md b/docs/database/README.md
@@ -0,0 +1,10 @@
+# Database
+
+The database used in the project is relational. The database diagram has been made on the website https://app.diagrams.net/ and is located in the `database_diagram` file. You can [click here](https://drive.google.com/file/d/1tFfF4Nxq9Zou3pdLlp1YsN1fobiYOWuc/view?usp=sharing) to see the diagram.
+If you need to make an edit to the diagram, you must follow the following steps:
+
+- Open the diagram at https://app.diagrams.net/
+- Make the necessary changes.
+- Update the last update and the version in the diagram title. You can follow the [version used for software](https://semver.org/).
+- Update the `database_diagram` document with the new version.
+- Update the `CHANGELOG.md` with your changes.