Skip to content
Snippets Groups Projects
Commit 8fce10a3 authored by s2536528's avatar s2536528
Browse files

Adding README.md for main directory of the project, as well as, one for the API.

parent 6e041782
No related branches found
No related tags found
No related merge requests found
Pipeline #85877 failed
......@@ -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)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment