Klassroom

Table of Contents

• Features
• Demo
• Technology Stack
• Run Locally
• Future Scope
• License
• Disclaimer
• Useful Links

Features

• Admin can add students and teachers
• Teachers can add students, create lectures, give and mark assignments
• Student can view lectures, can view and submit assignments
• Dedicated discussion forum for each classroom

Demo

You can use the below credentials to explore Klassroom.

Demo Credentials

Student

• Email: demo@example.com
• Password: superSecret56

Teacher

• On request

Admin

• On request

Click here for the Live Demo

Technology Stack

• VueJS 2.x
• Bulma CSS
• Buefy
• Firebase

Run Locally

Prerequisites

To run this project locally one should have -

• A Firebase project created (Refer Firebase Docs for more)

Get the repo

Download the .zip file from Github or run the below command to clone the repo locally.

git clone https://github.com/soumitdas/klassroom.git

Install dependencies

After cloning the repo, run the following commands to install the project dependencies:

# for Vue app
yarn install

# for Cloud functions
cd functions && npm install

Set environment

Set the environment variable in .env file at root directory.

VUE_APP_BASE_URL=http://localhost:8080/
VUE_APP_FIREBASE_CONFIG=paste_stringified_firebase_config_object_here

Deploy Cloud Functions

• Install the Firebase CLI
• Setup the CLI using firebase login (refer docs)
• Run the following commands to deploy functions

firebase deploy --only functions

Deploy firestore & storage security rules

firebase deploy --only firestore
firebase deploy --only storage

Run

yarn serve
# Vue App will start at PORT 8080

Future Scope

• Push / Email notification
• Rich text support
• More data in dashboard
• Report generation

License

Klassroom is MIT licensed.

Disclaimer

This project is in a very basic stage and might have severe bugs and vulnerabilities, so please keep that in mind when deploying it to production.

Useful Links

• Vue
• Firebase
• Bulma
• Base Template - Admin Two