From 8fce10a373dc66099fefd23420c9ffbc3ae12af4 Mon Sep 17 00:00:00 2001 From: iggy <i.kepka@student.utwente.nl> Date: Thu, 22 Feb 2024 14:00:41 +0100 Subject: [PATCH] Adding README.md for main directory of the project, as well as, one for the API. --- MySU/README.md | 0 README.md | 6 +++--- apps/MySU/README.md | 0 3 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 MySU/README.md create mode 100644 apps/MySU/README.md diff --git a/MySU/README.md b/MySU/README.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 81a087f..2eca278 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ This could prove beneficial in the future e.g., UT hosting a big event involving - **Calendar** is responsible for handling events provided by different associations. It contains information about: enrollment, enrollment options, event types, and events themselves. - **Email** is responsible for distributing emails to members of the various associations. - **Financial** is responsible for handling the finances of the associations and their particular members. Contains information about: bank accounts, debt entries, debt collections and invoices. -- **API [apps/MySU]** is responsible for handling the requests and responses between the frontend and backend. -- **Backend [MySU]** is a main part of the code that the other components are built upon. It handles all the major work and provides the functionality for the web application. +- **API [apps/MySU]** is responsible for handling the requests and responses between the frontend and backend. Contains own **README.md** file. +- **Backend [MySU]** is a main part of the code that the other components are built upon. It handles all the major work and provides the functionality for the web application. Contains own **README.md** file. - **Exams** and **Inventory** are **deprecated** and have no use for the main App, as of now. Can be found in "Unused Apps" directory. # It is assumed that: @@ -44,7 +44,7 @@ This could prove beneficial in the future e.g., UT hosting a big event involving - https://gitlab.utwente.nl/my-su/backend/api/-/wikis/Local-Installation - The installation is successful, if after running the project you can access the locally run API on URL: **http://127.0.0.1:8000/** -- Note that the local backend comes with pre-made "fixtures" that populate the djangoDB with dummy data. +- Note that the local backend comes with pre-made "fixtures" that populate the database with random data. # In order to properly setup the frontend, and link it locally with the backend and API of the applications: - clone the gitlab repository of the frontend (link can be found at the bottom of the document) diff --git a/apps/MySU/README.md b/apps/MySU/README.md new file mode 100644 index 0000000..e69de29 -- GitLab