Code Monkey home page Code Monkey logo

comp3000-learning-platform's Introduction

COMP3000

Project Vision

PersaLearn is a digital learning platform that incorporate game-design elements and principals. The goal of the platform is to create a more enjoyable learning experience that will make studying less of a chore.

Access

APK download

A download of the APK is available in the releases section of this GitHub.

Run Locally

Web, API and Database

From the root folder, with Docker installed on your system, simply run the following command in the terminal.
docker-compose -f docker-compose.yml -f docker-compose-dev.yml up --build -d
The website will then be accessable from http://localhost:3000/

Mobile Application

In order to start the mobile application first navigate to the MobileApp/persa-learn folder.
Then run the following commands:
npm install
npm start
You can then click the link produced by the terminal.
From the web page you can start the application in a local emulator by clicking corresponding button, located on the left side of the page (The emulator must be running before clicking the button.).
For the application to funcation correctly an instance of the database and API must be running locally.

Technologies

Web Application

React JS
Charts JS
React Router

Mobile Application

React Native
Expo

Server & Database

MYSQL
Node JS
JWT
Bcrypt JS

Testing

React Testing Library
Cypress

Networking

Docker

Database Structure (ERD)

ERD

Application Interfaces

Web Application

Login

Login

Admin

Dashboard

Stats

Items

Manage Items Manage Banners Manage Profile Pictures Manage Themes

Account Details

Account Details

Student

Dashboard

Dashboard Feed

Quiz

Quiz Quiz Complete Rating

Classes

Class Requests Students Classes

Shop

Shop

Flashcards

Flash Card decks Selected Deck Playing Deck Results

Teacher

Dashboard

Stats

Classes

Classes Classes Details Send Class Requests Classes Students Classes Submissions

Assignments

All Assignments Create/Edit Quiz

Account Details

Account Details

Mobile Application

Student

Home
Home Feed
Shop

Shop

User Details

User Details

Classes
Class Requests Classes
Quiz
Quiz Results Rating

comp3000-learning-platform's People

Contributors

jmchurchill avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.