An open API service indexing awesome lists of open source software.

https://github.com/cos301-se-2021/edugo

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.
https://github.com/cos301-se-2021/edugo

augmented-reality containerization continuous-integration software-engineering

Last synced: over 1 year ago
JSON representation

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.

Awesome Lists containing this project

README

          

# EduGo
#### by Gang of Five





## Table Of Contents
- [Project Overview](#books-project-overview)
- [EduGo Team Members](#people_holding_hands-edugo-team-members)
- [EduGo Systems](#bulb-edugo-systems)
- [Git Structure](#gear-git-structure)
- [Code Quality](#bar_chart-code-quality)
- [Technology Stack](#hammer_and_wrench-technology-stack)
- [Documententation](#page_facing_up-documentation)
- [Project Management Tool](#card_index_dividers-project-management-tool)
- [Contact us](#telephone_receiver-contact-us)
- [Stakeholders](#pushpin-stakeholders)




## :books: Project Overview
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. 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.




## :bulb: EduGo Systems

### Android App Release



### EduGo Web App




## :people_holding_hands: EduGo Team Members

| **Team Member** | **Profiles** | **Skills/Interest**
| :-----: | :-----: | :-----: |
| [](https://github.com/sthenyandeni "Sithembiso Nyandeni")
Sithembiso Nyandeni
u19091479 | [GitHub](https://github.com/sthenyandeni)
[Profile Page](https://github.com/sthenyandeni)
[LinkedIn](https://www.linkedin.com/in/sithembiso-nyandeni-b8884b1b2)
| Software Development
Music
Design

| [](https://github.com/simekani18 "Simekani Mabambi")
Simekani Mabambi
u19134101 | [GitHub](https://github.com/simekani18)
[Profile Page](https://github.com/simekani18)
[LinkedIn](https://www.linkedin.com/in/simekani/)
|Sport
Software Development

| [](https://github.com/kieran-woodrow "Kieran Woodrow")
Kieran Woodrow
u19304308 | [GitHub](https://github.com/kieran-woodrow)
[Profile Page](https://github.com/kieran-woodrow)
[LinkedIn](https://www.linkedin.com/in/kieran-woodrow-3b915b210/)
| Software Development
Applied Mathamatics
Teaching

| [](https://github.com/MihlaliMgwebi "Mihlali Mgwebi")
Mihlali Mgwebi
u19187166 | [GitHub](https://github.com/MihlaliMgwebi)
[Profile Page](https://github.com/MihlaliMgwebi)
[LinkedIn](https://www.linkedin.com/in/mihlali-mgwebi-161a83208)
| Gyming
Skating
Software Development

| [](https://github.com/Tshwarelo-Noah "Noah Mafarala")
Noah Mafarala
u19181851 | [GitHub](https://github.com/Tshwarelo-Noah)
[Profile Page](https://github.com/Tshwarelo-Noah)
[LinkedIn](https://www.linkedin.com/in/noah-mafaralala-815760178/)
| Trading
Music
Food



## :gear: Git Structure
### Branching Strategy

master ( build )

      − develop - backend ( build )

            − develop-backend−feature

      − develop - mobile ( build )

            − develop-mobile−feature

      − develop - web ( build )

            − develop-web−feature


## :bar_chart: Code Quality
[![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)
![GitHub API Build](https://img.shields.io/github/workflow/status/COS301-SE-2021/EduGo/API%20Build?label=API%20Build)


## :hammer_and_wrench: Technology Stack

### Front end for Web App

![AGPL License](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white)
![AGPL License](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge&logo=dart&logoColor=white)

### Front end for Android App

![AGPL License](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white)
![AGPL License](https://img.shields.io/badge/Dart-0175C2?style=for-the-badge&logo=dart&logoColor=white)

### Backend

![AGPL License](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![AGPL License](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
![AGPL License](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
![AGPL License](https://img.shields.io/badge/Express.js-000000?style=for-the-badge&logo=express&logoColor=white)
![AGPL License](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=Postman&logoColor=white)

### Database

![AGPL License](https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white)

### Storage and Hosting

![AGPL License](https://img.shields.io/badge/microsoft%20azure-0089D6?style=for-the-badge&logo=microsoft-azure&logoColor=white)


### Container

![AGPL License](https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white)

### Testing

![AGPL License](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)
![AGPL License](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)

### Design Tools

![AGPL License](https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge&logo=figma&logoColor=white)


## :page_facing_up: Documentation:
### SRS Document


### Architectural Requirements


### User Manual






### Installation Manual





### Coding Standards



### Testing Quality Document






### Demo Recordings


## :card_index_dividers: Project Management Tool

![AGPL License](https://img.shields.io/badge/Git-F05032?style=for-the-badge&logo=git&logoColor=white)
![AGPL License](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)
![AGPL License](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)
![AGPL License](https://img.shields.io/badge/Google%20Meet-32A350?style=for-the-badge&logo=google-meet&logoColor=white)
![AGPL License](https://img.shields.io/badge/Overleaf-47A141?style=for-the-badge&logo=Overleaf&logoColor=white)
![AGPL License](https://img.shields.io/badge/Basecamp-47A141?style=for-the-badge&color=yellow)


## :telephone_receiver: Contact us




## :pushpin: Stakeholders

### University of Pretoria Computer Science Department


Logo

### 5DT


Logo