EdTech

About • Features • Technologies • Environment variables • How to run • API endpoints • License

About

EdTech is a web application that aims to connect students and teachers in a simple and intuitive way. It was inspired by the LWS platform.

Features

• Students can register on the platform by sending:
  • Name
  • Email
  • Password
  • Avatar (optional)
• Students can log in to the platform by sending:
  • Email
  • Password
• Students can update their:
  • Avatar
• Students can recover their password by sending:
  • Email
• Student can change their password by sending:
  • New password
  • Password confirmation
• Admin can log in to the platform by sending:
  • Email
  • Password
• Admin can course videos by sending:
  • Title
  • Description
  • Video URL
  • Thumbnail URL
• Admin can add quizzes to courses by sending:
  • Title
  • Questions with:
    • Title
    • Options
      • Title
      • Is correct
• Admin can add assignments by sending:
  • Title
  • Description
  • Due date
  • Total marks
• Admin can add update submitted assignments by sending:
  • Marks
  • Feedback

Technologies

The following tools were used in the construction of the project:

Client

• NextJs
• TypeScript
• Ant Design
• Redux Toolkit
• RTK Query
• Redux Persist
• React Markdown
• React Player

Server

• NodeJs
• Express
• Cloudinary
• JWT
• Passport
• NodeMailer
• Handlebars
• MongoDB
• Mongoose
• Bcrypt
• Joi
• Helmet
• http-status

Env setup

Client

1. Create a .env.local file in the root of the client folder
2. Add the following environment variables

#API
NEXT_PUBLIC_API_URL=<API Url>
NEXT_PUBLIC_PAGE_SIZE=10

Server

1. Create a .env file in the root of the server folder
2. Add the following environment variables

# Port number
NODE_ENV=development
PORT='<Port number>'

# URL of the app
APP_URL=<Client URL>

# URL of the Mongo DB
MONGODB_URL='<MongoDB URL>'

# JWT
# JWT secret key
JWT_SECRET='<Secret key>'
# Number of minutes after which an access token expires
JWT_ACCESS_EXPIRATION_MINUTES='<Number of minutes>'
# Number of days after which a refresh token expires
JWT_REFRESH_EXPIRATION_DAYS='<Number of days>'
# Number of minutes after which a reset password token expires
JWT_RESET_PASSWORD_EXPIRATION_MINUTES='<Number of minutes>'
# Number of minutes after which a verify email token expires
JWT_VERIFY_EMAIL_EXPIRATION_MINUTES='<Number of minutes>'

# SMTP configuration options for the email service
# For testing, you can use a fake SMTP service like Ethereal: https://ethereal.email/create
SMTP_HOST='<SMTP host>'
SMTP_PORT='<SMTP port>'
SMTP_USERNAME='<SMTP username>'
SMTP_PASSWORD='<SMTP password>'
EMAIL_FROM='<Email from>'

# Cloudinary account credentials
CLOUDINARY_CLOUD_NAME='<Cloudinary cloud name>'
CLOUDINARY_API_KEY='<Cloudinary API key>'
CLOUDINARY_API_SECRET='<Cloudinary API secret>'

How to run

1. Clone this repository

git clone https://github.com/b-l-i-n-d/edTech.git

2. Install dependencies

   Server

   cd server
   yarn

   Client

   cd client
   yarn

3. Run the application

   Server

   yarn dev

   Client

   yarn dev

4. You can optionally build the application

   Server

   yarn start

   Client

   yarn build

API endpoints

Auth

Route	Method	Description
/v1/auth/register	POST	Register a new user
/v1/auth/login	POST	Login a user
/v1/auth/logout	POST	Logout a user
/v1/auth/refresh-tokens	POST	Refresh access token
/v1/auth/forgot-password	POST	Send password reset email
/v1/auth/reset-password	POST	Reset password
/v1/auth/reset-password	POST	Reset password
/v1/auth/send-verification-email	POST	Send email verification email
/v1/auth/verify-email	POST	Verify email

Users

Route	Method	Description
/v1/users	GET	Get all users
/v1/users	POST	Create new user
/v1/users/:userId	GET	Get a user
/v1/users/:userId	PATCH	Update a user
/v1/users/:userId	DELETE	Delete a user

Videos

Route	Method	Description
/v1/videos	GET	Get all videos
/v1/videos	POST	Create new video
/v1/videos/:videoId	GET	Get a video
/v1/videos/:videoId	PATCH	Update a video
/v1/videos/:videoId	DELETE	Delete a video

Quizzes

Route	Method	Description
/v1/quizzes	GET	Get all quizzes
/v1/quizzes	POST	Create new quiz
/v1/quizzes/:quizId	GET	Get a quiz
/v1/quizzes/:quizId	PATCH	Update a quiz
/v1/quizzes/:quizId	DELETE	Delete a quiz

Assignments

Route	Method	Description
/v1/assignments	GET	Get all assignments
/v1/assignments	POST	Create new assignment
/v1/assignments/:assignmentId	GET	Get a assignment
/v1/assignments/:assignmentId	PATCH	Update a assignment
/v1/assignments/:assignmentId	DELETE	Delete a assignment

Quizz Sets

Route	Method	Description
/v1/quizzes-sets	GET	Get all quizzes sets

Quizz Marks

Route	Method	Description
/v1/quizzes-marks	GET	Get all quizzes marks
/v1/quizzes-marks	POST	Create new quiz mark

Assignment Marks

Route	Method	Description
/v1/assignments-marks	GET	Get all assignments marks
/v1/assignments-marks	POST	Create new assignment mark
/v1/assignments-marks/:assignmentMarkId	GET	Get a assignment mark
/v1/assignments-marks/:assignmentMarkId	PATCH	Update a assignment mark
/v1/assignments-marks/:assignmentMarkId	DELETE	Delete a assignment mark

Dashboard

Route	Method	Description
/v1/dashboard	GET	Get all required data for a users

Leaderboard

Route	Method	Description
/v1/leaderboard	GET	Get all users with their rank

Docs

Route	Method	Description
/docs	GET	Get all docs

Screenshots

Auth

Login

Register

Forgot password

Home

User

Course Access

Dashboard

Leaderboard

Profile

Change password

Admin

Dashboard

Videos

All videos

Add video

Edit video

View video

Quizzes

All quizzes

Add quiz

Edit quiz

View quiz

Assignments

All assignments

Add assignment

Edit assignment

View assignment

Assignments marks

All assignments marks

Edit assignment mark

View assignment mark

License

MIT