Skip to content

chingu-voyages/v42-bears-team-27

Repository files navigation

RemoteClass

(Logo thumbnail


Overview

The aim of this project is to deliver an education platform for both teachers and students, where students can progress outside of class via lessons, exercises and tests set by teachers, as well as provide an overall fun, learning experience for them.

Features

  • Access and manage your very own dashboard as either a student or teacher
  • Readily available interactive resources for students at their finger tips
  • Connect with students as a teacher at both a classroom and individual level
  • Schedule classroom events for students and see how well they do overall
  • View classroom events as a student to see what your teacher have set for you

Running this project locally

From this repo:

  1. Clone this project locally

  2. Install the required dependencies for this project

  # yarn
  $ yarn
  # npm
  $ npm i
  1. Use the populateDB.js in script in the backend packages
  # ./packages/backend
  $ node populateDB.js 'MONGODB_CONNECTION_STRING'
  1. Setup your .env files for both frontend/backend packages

  2. Run the dev command to build the web app on watch mode

  # yarn
  $ yarn dev
  # npm
  $ npm run dev

Dependencies

Frontend

Backend

Monorepo

Maintainers

A special thanks to the team at Chingus for helping making this possible!