From 2806d16d8d48582902218bb1db457f37c7dd1273 Mon Sep 17 00:00:00 2001 From: Lukas Anthonissen Date: Tue, 24 Oct 2023 22:00:10 +0200 Subject: [PATCH] Update README.md for Project Day --- README.md | 129 ++---------------------------------------------------- 1 file changed, 4 insertions(+), 125 deletions(-) diff --git a/README.md b/README.md index ca4a5c44..7e86fb62 100644 --- a/README.md +++ b/README.md @@ -10,131 +10,10 @@ The wireless sensors connect in a mesh-like topology to feed RSSI data to a wire The system uses Google Authentication to ensure security and privacy of the data and enforces role-based access control to ensure that only authorised users can access the data. -## Installation and Setup +## Links to required documentation for Project Day -Please refer to our [technical installation manual](https://github.com/COS301-SE-2023/Event-Participation-Trends/wiki/Technical-Installation-Manual). +[GitHub Wiki](https://github.com/COS301-SE-2023/Event-Participation-Trends/wiki/Required-Documents) -## About Us +## System Documentation on GitHub Wiki - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
MemberRoleDescriptionProfiles
- Lukas Anthonissen
- u21434345

-

- 		Project manager and AI engineer - Lukas is responsible for team management, project administration, documentation, and sprint planning, as well as the design of the User Interface. He researched and implemented the ratio-based trilateration positioning service, and mathematical filters that build upon it, that allow the system to estimate the participant positions. - - - -

- - - -
- Stefan van der Merwe
- u21429121

- - 		Hardware and DevOps engineer - Stefan is our DevOps and hardware guy. He created the firmware running on the ESP32-C3 Espressif Microcontroller, and the communication of those sensors with our API. He also handled the setting up of the VPS 
that our project is running on and our CI/CD pipeline. - - - -

- - - -
- Reuben Jooste
- u21457060

- - 		UX/UI Designer and Front-end Engineer - Reuben is one of our front-end designers and developers. He designed and implemented both the dashboard, and compare pages. Reuben also implemented the functionality of displaying the heatmaps and other statistics on the dashboard. He was also responsible for the integration between the front end and back end. - - - -

- - - -
- Arno Jooste
- u21457451

- - 		UX/UI Designer and Front-end Engineer - Arno is our other front-end designer and developer. He implemented the floor plan editing tool, which allows an event manager to create/edit a floor plan for an event space. Arno was also responsible for integration between the front end and back end. - - - -

- - - -
- Luca Loubser
- u20439963

- - 		Back-end and Database Engineer - Luca is our API and Database Engineer. He was responsible for design, implementation and documentation of the API and Database. He was also responsible for the testing of the API through: Unit and Integration tests. - - - -

- - - -
- - - - -## Links - -| Description | Link | -| --------------------------------- | -------------------------------------------------------------------------------------------------------- | -| System Requirements Specification v1 | [Link](https://docs.google.com/document/d/1Doeb5QJNxG2spNTYSLdacT7NHsnLVPAS4rcuX1nRqrY/edit?usp=sharing) | -| System Requirements Specification v2 | [Link](https://docs.google.com/document/d/1iHdudGcnUYoy227o1OgBhCBoATmbfdSvOFCusW7_F54/edit?usp=sharing) | -| System Requirements Specification v3 | [Link](https://docs.google.com/document/d/1L8ZUmRvCnAo5dGfTijhnKHm9DuSSltOG0WrvUgLysvg/edit?usp=sharing) | -| System Requirements Specification v4 | [Link](https://docs.google.com/document/d/15h4X2jm_uBKAbkQX41ua-sZuAcgC_iCVEYdanp-sj9s/edit?usp=sharing) | -| Architecture Requirements Document | [Link](https://docs.google.com/document/d/1DCmlr6tthxqHlV5Asj0hk7cu2i9cDNINY6NU2OYsUmg/edit?usp=sharing) -| Notion | [Link](https://tricky-cylinder-c7d.notion.site/Indlovu-Event-Participant-Trends-c0a953a23efe4de1969fc2a8a46cb7e5?pvs=4) | -| Coding Standards Document | [Link](https://www.notion.so/Coding-Standards-7b82311f246d445c835abcd739321909?pvs=4) | -| Documentation Contributions | [Link](https://www.notion.so/List-of-Contributions-1c60a373935440e383232a35eac06898?pvs=4) | -| User Manual | [Link](https://docs.google.com/document/d/1_cKCrhkL_yB80d10c_E82UGZVLFnSZI2S8DJMGUVsJ0/edit?usp=sharing) -| Technical Installation Manual | [Link](https://github.com/COS301-SE-2023/Event-Participation-Trends/wiki/Technical-Installation-Manual) | -| Installation Instructions (Mobile Users) | [Link](https://github.com/COS301-SE-2023/Event-Participation-Trends/wiki/Installation-instructions-(Mobile-users)) | +[GitHub Wiki](https://github.com/COS301-SE-2023/Event-Participation-Trends/wiki)