{"id":26434060,"url":"https://github.com/cos301-se-2021/edugo","last_synced_at":"2025-03-18T07:20:13.376Z","repository":{"id":46614745,"uuid":"369604348","full_name":"COS301-SE-2021/EduGo","owner":"COS301-SE-2021","description":"EduGo is an educational system that aims to shape and influence the future of education through the use of Augmented Reality technology. The objective is to allow students to view AR entities through the use of their phones to enhance their learning experiences. ","archived":false,"fork":false,"pushed_at":"2021-10-14T06:02:04.000Z","size":103371,"stargazers_count":1,"open_issues_count":5,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-03-09T23:36:32.401Z","etag":null,"topics":["augmented-reality","containerization","continuous-integration","software-engineering"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/COS301-SE-2021.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-21T17:11:25.000Z","updated_at":"2022-02-24T23:08:47.000Z","dependencies_parsed_at":"2022-07-19T14:42:10.524Z","dependency_job_id":null,"html_url":"https://github.com/COS301-SE-2021/EduGo","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/COS301-SE-2021%2FEduGo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/COS301-SE-2021%2FEduGo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/COS301-SE-2021%2FEduGo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/COS301-SE-2021%2FEduGo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/COS301-SE-2021","download_url":"https://codeload.github.com/COS301-SE-2021/EduGo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244173464,"owners_count":20410303,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["augmented-reality","containerization","continuous-integration","software-engineering"],"created_at":"2025-03-18T07:20:12.604Z","updated_at":"2025-03-18T07:20:13.348Z","avatar_url":"https://github.com/COS301-SE-2021.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# EduGo\n#### by Gang of Five\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/COS301-SE-2021/EduGo\"\u003e\n    \u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/unknown.png\"  width=\"600\" height=\"200\"\u003e \u003c/a\u003e\n  \n\u003c!--  Change edugo photo here --\u003e\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n ## Table Of Contents\n- [Project Overview](#books-project-overview)\n- [EduGo Team Members](#people_holding_hands-edugo-team-members)\n- [EduGo Systems](#bulb-edugo-systems)\n- [Git Structure](#gear-git-structure)\n- [Code Quality](#bar_chart-code-quality)\n- [Technology Stack](#hammer_and_wrench-technology-stack)\n- [Documententation](#page_facing_up-documentation)\n- [Project Management Tool](#card_index_dividers-project-management-tool)\n- [Contact us](#telephone_receiver-contact-us)\n- [Stakeholders](#pushpin-stakeholders)\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n  \n## :books: Project Overview\nEduGo is an educational system that aims to shape and influence the future of education through the use of Augmented Reality technology. The objective is to allow students to view AR entities through the use of their phones to enhance their learning experiences. The system will also allow educators to create subjects, add lessons to the subjects and will also enable educators to add virtual entities -along with quizzes about the virtual entity- to a lesson.\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n  \n## :bulb: EduGo Systems\n\n  ### Android App Release\n   \u003cul\u003e\n    \u003cli\u003e :iphone: \u003ca href='https://github.com/COS301-SE-2021/EduGo/releases/tag/v1.0'\u003eRelease v1.0\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n  \n  ### EduGo Web App\n  \u003cul\u003e\n    \u003cli\u003e :desktop_computer: \u003ca href='http://edugo-backend.southafricanorth.cloudapp.azure.com/'\u003eEduGo Web App\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n  \n\n  \n  \n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :people_holding_hands: EduGo Team Members\n\n| **Team Member** | **Profiles** | **Skills/Interest**\n| :-----: | :-----: | :-----: |\n| [\u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/1614194042425.jpeg\" width=\"150\" height=\"150\"\u003e](https://github.com/sthenyandeni \"Sithembiso Nyandeni\") \u003cbr/\u003e Sithembiso Nyandeni \u003cbr/\u003e u19091479 | [GitHub](https://github.com/sthenyandeni) \u003cbr/\u003e [Profile Page](https://github.com/sthenyandeni) \u003cbr/\u003e [LinkedIn](https://www.linkedin.com/in/sithembiso-nyandeni-b8884b1b2) \u003cbr/\u003e | Software Development \u003cbr/\u003e Music \u003cbr/\u003e Design \u003cbr/\u003e\n| [\u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/1594897821188.jpg\" width=\"150\" height=\"150\"\u003e](https://github.com/simekani18 \"Simekani Mabambi\") \u003cbr/\u003e Simekani Mabambi \u003cbr/\u003e u19134101 | [GitHub](https://github.com/simekani18) \u003cbr/\u003e [Profile Page](https://github.com/simekani18) \u003cbr/\u003e [LinkedIn](https://www.linkedin.com/in/simekani/) \u003cbr/\u003e |Sport \u003cbr/\u003e Software Development \u003cbr/\u003e\n| [\u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/1E96D130-B906-49D0-9B69-29463C879C4D.jpeg\" width=\"150\" height=\"150\"\u003e](https://github.com/kieran-woodrow \"Kieran Woodrow\") \u003cbr/\u003e Kieran Woodrow \u003cbr/\u003e u19304308 | [GitHub](https://github.com/kieran-woodrow) \u003cbr/\u003e [Profile Page](https://github.com/kieran-woodrow) \u003cbr/\u003e [LinkedIn](https://www.linkedin.com/in/kieran-woodrow-3b915b210/) \u003cbr/\u003e | Software Development \u003cbr/\u003e Applied Mathamatics \u003cbr/\u003e Teaching \u003cbr/\u003e\n| [\u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/mish.png\" width=\"150\" height=\"150\"\u003e](https://github.com/MihlaliMgwebi \"Mihlali Mgwebi\") \u003cbr/\u003e Mihlali Mgwebi \u003cbr/\u003e u19187166 | [GitHub](https://github.com/MihlaliMgwebi) \u003cbr/\u003e [Profile Page](https://github.com/MihlaliMgwebi) \u003cbr/\u003e [LinkedIn](https://www.linkedin.com/in/mihlali-mgwebi-161a83208) \u003cbr/\u003e | Gyming  \u003cbr/\u003eSkating  \u003cbr/\u003e Software Development \u003cbr/\u003e\n| [\u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/68747470733a2f2f656475676f2d66696c65732e73332e61662d736f7574682d312e616d617a6f6e6177732e636f6d2f57686174734170702b496d6167652b323032312d30382d31352b61742b32322e30312e31392e6a706567.jpeg\" width=\"150\" height=\"150\"\u003e](https://github.com/Tshwarelo-Noah \"Noah Mafarala\") \u003cbr/\u003e Noah Mafarala \u003cbr/\u003e u19181851 | [GitHub](https://github.com/Tshwarelo-Noah) \u003cbr/\u003e [Profile Page](https://github.com/Tshwarelo-Noah) \u003cbr/\u003e [LinkedIn](https://www.linkedin.com/in/noah-mafaralala-815760178/) \u003cbr/\u003e | Trading  \u003cbr/\u003eMusic  \u003cbr/\u003e Food \u003cbr/\u003e\n  \n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :gear: Git Structure\n### Branching Strategy\n\nmaster ( build )\n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop - backend ( build )\n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop-backend−feature \n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop - mobile ( build )\n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop-mobile−feature \n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop - web ( build )\n\u003c/br\u003e\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;− develop-web−feature \n\u003c/br\u003e\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :bar_chart: Code Quality\n[![GitHub pull-requests](https://img.shields.io/github/issues-pr/COS301-SE-2021/EduGo?label=Pull%20Requests)](https://github.com/COS301-SE-2021/EduGo/pulls)\n![GitHub API Build](https://img.shields.io/github/workflow/status/COS301-SE-2021/EduGo/API%20Build?label=API%20Build)\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :hammer_and_wrench: Technology Stack \n\u003c!-- add all tags here and all proper info --\u003e\n\n### Front end for Web App \n\n  ![AGPL License](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge\u0026logo=flutter\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge\u0026logo=dart\u0026logoColor=white)\n\n### Front end for Android App \n  \n  ![AGPL License](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge\u0026logo=flutter\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge\u0026logo=dart\u0026logoColor=white)\n  \n### Backend\n\n![AGPL License](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![AGPL License](https://img.shields.io/badge/Node.js-339933?style=for-the-badge\u0026logo=nodedotjs\u0026logoColor=white)\n![AGPL License](https://img.shields.io/badge/npm-CB3837?style=for-the-badge\u0026logo=npm\u0026logoColor=white)\n![AGPL License](https://img.shields.io/badge/Express.js-000000?style=for-the-badge\u0026logo=express\u0026logoColor=white)\n![AGPL License](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge\u0026logo=Postman\u0026logoColor=white)\n   \n### Database \n\n![AGPL License](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)\n   \n### Storage and Hosting\n\n![AGPL License](https://img.shields.io/badge/microsoft%20azure-0089D6?style=for-the-badge\u0026logo=microsoft-azure\u0026logoColor=white)\n   \n   \n### Container \n\n![AGPL License](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge\u0026logo=docker\u0026logoColor=white)\n  \n### Testing\n\n![AGPL License](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge\u0026logo=eslint\u0026logoColor=white)\n![AGPL License](https://img.shields.io/badge/Jest-C21325?style=for-the-badge\u0026logo=jest\u0026logoColor=white)\n\n### Design Tools\n\n![AGPL License](https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge\u0026logo=figma\u0026logoColor=white)\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :page_facing_up: Documentation:\n### SRS Document\n\u003cul\u003e\n  \u003cli\u003e :label: \u003ca href='https://drive.google.com/file/d/155tzN0i0L5boADjVT66ph0Kj6ujAIsib/view?usp=sharing'\u003e SRS \u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr\u003e\n\n### Architectural Requirements\n\u003cul\u003e\n   \u003cli\u003e :open_book: \u003ca href='https://drive.google.com/file/d/1erj2GkLlnE_IGfBH7_o9OUnuryptbh_r/view?usp=sharing'\u003eArchitectural Requirements Document\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr\u003e\n\n### User Manual\n\u003cul\u003e\n \u003cli\u003e :page_with_curl: \u003ca href='https://drive.google.com/file/d/17ar46Ac1n__3wUsx3qsb0DGWDZ6En5HA/view?usp=sharing'\u003eUser Manual\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n \n \u003chr\u003e\n \n### Installation Manual\n\u003cul\u003e\n \u003cli\u003e :bell: \u003ca href='https://drive.google.com/file/d/1x5zNR04yCAaC05IQsMMvT_fstOvrRHBu/view?usp=sharing'\u003eTechnical Installation Manual\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n \n \u003chr\u003e\n \n### Coding Standards\n\u003cul\u003e\n \u003cli\u003e :pencil: \u003ca href='https://drive.google.com/file/d/1lD0U4w0lQHLxK8LwYes7YboLhW3yFTVA/view?usp=sharing'\u003eCoding Standards Document\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n \n\u003chr\u003e\n\n### Testing Quality Document\n\u003cul\u003e\n \u003cli\u003e :mag_right: \u003ca href='https://drive.google.com/file/d/1WwdnOAkNXvSVU_khakMsPA0sXwgjziQv/view?usp=sharing'\u003eTesting Quality Document\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n \n\u003chr\u003e\n \n###  Demo Recordings\n\u003cul\u003e\n  \u003cli\u003e :tv: \u003ca href='https://drive.google.com/file/d/1RIXQcITcelj4GaSmUtWqXE0fi6j3JdLS/view?usp=sharing'\u003eDemo 1\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e :tv: \u003ca href='https://drive.google.com/file/d/1iHJgScCNGbikE3fsQw5rotdFBa3A0Bus/view?usp=sharing'\u003eDemo 2\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e :tv: \u003ca href='https://drive.google.com/file/d/1WuS3KmJ2zxvCAIW9hqg81GTnNJTXkC86/view?usp=sharing'\u003eDemo 3\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e :tv: \u003ca href='https://drive.google.com/file/d/1deYmlztBeZu7jPyCivCjT_rSXdYbLjte/view?usp=sharing'\u003eDemo 4\u003c/a\u003e\u003c/li\u003e\n \u003c/ul\u003e\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :card_index_dividers: Project Management Tool\n\n  ![AGPL License](https://img.shields.io/badge/Git-F05032?style=for-the-badge\u0026logo=git\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/GitHub-100000?style=for-the-badge\u0026logo=github\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge\u0026logo=discord\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/Google%20Meet-32A350?style=for-the-badge\u0026logo=google-meet\u0026logoColor=white)\n  ![AGPL License](https://img.shields.io/badge/Overleaf-47A141?style=for-the-badge\u0026logo=Overleaf\u0026logoColor=white) \n  ![AGPL License](https://img.shields.io/badge/Basecamp-47A141?style=for-the-badge\u0026color=yellow)\n\n\u003cul\u003e\n   \u003cli\u003e :paperclip: \u003ca href='https://github.com'\u003e GitHub for version control \u003c/a\u003e\u003c/li\u003e  \n   \u003cli\u003e :paperclip: \u003ca href='https://3.basecamp.com/5098601/projects/22442122'\u003e Basecamp for managing all project tasks \u003c/a\u003e\u003c/li\u003e\n   \u003cli\u003e :paperclip: \u003ca href='https://discord.com/'\u003e Discord for all Gang Of Five team meetings \u003c/a\u003e\u003c/li\u003e\n   \u003cli\u003e :paperclip: \u003ca href='https://meet.google.com/'\u003e Google meets used for meeting with the Business client Stakeholders \u003c/a\u003e\u003c/li\u003e\n   \u003cli\u003e :paperclip: \u003ca href='https://eduvation.up.ac.za/students/index.php/blackboard-collaborate'\u003e BlackBoard Collaborate used for meeting with the Computer Science Dempartment Stakeholders \u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :telephone_receiver: Contact us\n  \u003cul\u003e\n     \u003cli\u003e :iphone: Gang Of Five Team Email: \u003ca href='mailto:gangoffive301@gmail.com'\u003e gangoffive301@gmail.com\u003c/a\u003e\u003c/li\u003e\n     \u003cli\u003e :iphone: 5DT Client Email: \u003ca href='mailto:ulrik.demuelenaere@5dt.com'\u003eulrik.demuelenaere@5dt.com \u003c/a\u003e\u003c/li\u003e\n     \u003cli\u003e :iphone: University of Pretoria COS301 Module Co-Ordinator Email \u003ca href='mailto:stacey.baror@cs.up.ac.za'\u003e stacey.baror@cs.up.ac.za \u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n  \n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n## :pushpin: Stakeholders\n  \n### University of Pretoria Computer Science Department\n\n  \u003ca href=\"https://www.up.ac.za/\"\u003e\n    \u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/up_logo.jpg\" alt=\"Logo\" width=\"300\" height=\"200\"\u003e \u003c/a\u003e\n\n### 5DT\n\n  \u003ca href=\"https://5dt.com/?gclid=CjwKCAjw4qCKBhAVEiwAkTYsPNJ6GF6DXGp_9g6OxlRG-xvLD76Lfc_HNh1SLWGZe9Y1D--Oo0XLLxoC9gYQAvD_BwE\"\u003e\n    \u003cimg src=\"https://edugo.blob.core.windows.net/edugo/readme/5dtlogo.png\" alt=\"Logo\" width=\"300\" height=\"200\"\u003e \u003c/a\u003e\n    \n    \n\u003chr style=\" border-top: 4px solid #bbb; border-radius: 2px;\"\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcos301-se-2021%2Fedugo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcos301-se-2021%2Fedugo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcos301-se-2021%2Fedugo/lists"}