From deabd5598e1f0a77c32ca3c2f4265fd32828f4e1 Mon Sep 17 00:00:00 2001 From: iggy <i.kepka@student.utwente.nl> Date: Wed, 21 Feb 2024 12:33:29 +0100 Subject: [PATCH] Polished README.md for the project. Made sure that the deletion of all private files did not affect the functionality of the frontend. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0016944..29d3518 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ # MySU is a member administration tool used to provide a common platform for any association willing to be a part of it. ### Backend of MySU is divided into several components: +- **Buddy** is responsible for matching different users of the app. Currently, the application is in no way linked to the frontend, but is required for it to run. - **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. -- **Buddy**, **Exams** and **Inventory** are **deprecated** and have no use for the main App, as of now. Can be found in "Unused Apps" directory. +- **Exams** and **Inventory** are **deprecated** and have no use for the main App, as of now. Can be found in "Unused Apps" directory. -## In order to properly setup the MySU application in local environment, follow -## [More information about Backend can be found here.](https://gitlab.utwente.nl/my-su/backend/api) -## [More information about Frontend can be found here.](https://gitlab.utwente.nl/my-su/frontend/website) \ No newline at end of file +## In order to properly setup the backend/API of MySU application in local environment, follow: +- https://gitlab.utwente.nl/my-su/backend/api/-/wikis/home +- https://gitlab.utwente.nl/my-su/backend/api/-/wikis/Local-Installation + +## It is assumed that: +- The current administrator is acquainted with the basics of Django, Django-API frameworks (Backend/API) +- The current administrator is acquainted with the basics of Node.js (Frontend) + +## [More information about the Backend can be found here.](https://gitlab.utwente.nl/my-su/backend/api) +## [More information about the Frontend can be found here.](https://gitlab.utwente.nl/my-su/frontend/website) \ No newline at end of file -- GitLab