https://github.com/b-l-i-n-d/edtech

A edTech platform using mongoDB, express, nextjs and nodejs
https://github.com/b-l-i-n-d/edtech
ant-design cloudinary expressjs handlebars joi jwt mongodb mongoose nextjs passportjs reactmarkdown reactplayer redux-toolkit reduxpersist rtk-query typescript
Last synced: 3 months ago
JSON representation
A edTech platform using mongoDB, express, nextjs and nodejs
Host: GitHub
URL: https://github.com/b-l-i-n-d/edtech
Owner: b-l-i-n-d
License: mit
Created: 2023-08-15T06:20:37.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2023-08-15T15:57:42.000Z (about 2 years ago)
Last Synced: 2025-05-24T11:09:28.031Z (5 months ago)
Topics: ant-design, cloudinary, expressjs, handlebars, joi, jwt, mongodb, mongoose, nextjs, passportjs, reactmarkdown, reactplayer, redux-toolkit, reduxpersist, rtk-query, typescript
Language: TypeScript
Homepage: https://ed-tech-six.vercel.app
Size: 4.46 MB
Stars: 3
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project

README

          
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](www.learnwithsumit.com) platform.

## Features

-   [x] Students can register on the platform by sending:

    -   [x] Name

    -   [x] Email

    -   [x] Password

    -   [x] Avatar (optional)

-   [x] Students can log in to the platform by sending:

    -   [x] Email

    -   [x] Password

-   [x] Students can update their:

    -   [x] Avatar

-   [x] Students can recover their password by sending:

    -   [x] Email

-   [x] Student can change their password by sending:

    -   [x] New password

    -   [x] Password confirmation

-   [x] Admin can log in to the platform by sending:

    -   [x] Email

    -   [x] Password

-   [x] Admin can course videos by sending:

    -   [x] Title

    -   [x] Description

    -   [x] Video URL

    -   [x] Thumbnail URL

-   [x] Admin can add quizzes to courses by sending:

    -   [x] Title

    -   [x] Questions with:

        -   [x] Title

        -   [x] Options

            -   [x] Title

            -   [x] Is correct

-   [x] Admin can add assignments by sending:

    -   [x] Title

    -   [x] Description

    -   [x] Due date

    -   [x] Total marks

-   [x] Admin can add update submitted assignments by sending:

    -   [x] Marks

    -   [x] Feedback

## Technologies

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

### Client

-   [NextJs](https://nextjs.org/)

-   [TypeScript](https://www.typescriptlang.org/)

-   [Ant Design](https://ant.design/)

-   [Redux Toolkit](https://redux-toolkit.js.org/)

-   [RTK Query](https://redux-toolkit.js.org/rtk-query/overview)

-   [Redux Persist](https://www.github.com/rt2zz/redux-persist)

-   [React Markdown](https://www.npmjs.com/package/react-markdown)

-   [React Player](https://www.npmjs.com/package/react-player)

### Server

-   [NodeJs](https://nodejs.org/en/)

-   [Express](https://expressjs.com/)

-   [Cloudinary](https://cloudinary.com/)

-   [JWT](https://jwt.io/)

-   [Passport](http://www.passportjs.org/)

-   [NodeMailer](https://nodemailer.com/about/)

-   [Handlebars](https://handlebarsjs.com/)

-   [MongoDB](https://www.mongodb.com/)

-   [Mongoose](https://mongoosejs.com/)

-   [Bcrypt](https://www.npmjs.com/package/bcrypt)

-   [Joi](https://www.npmjs.com/package/joi)

-   [Helmet](https://helmetjs.github.io/)

-   [http-status](https://www.npmjs.com/package/http-status)

## Env setup

### Client

1. Create a `.env.local` file in the root of the client folder

2. Add the following environment variables

```bash

#API

NEXT_PUBLIC_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

```bash

# Port number

NODE_ENV=development

PORT=''

# URL of the app

APP_URL=

# URL of the Mongo DB

MONGODB_URL=''

# JWT

# JWT secret key

JWT_SECRET=''

# Number of minutes after which an access token expires

JWT_ACCESS_EXPIRATION_MINUTES=''

# Number of days after which a refresh token expires

JWT_REFRESH_EXPIRATION_DAYS=''

# Number of minutes after which a reset password token expires

JWT_RESET_PASSWORD_EXPIRATION_MINUTES=''

# Number of minutes after which a verify email token expires

JWT_VERIFY_EMAIL_EXPIRATION_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_PORT=''

SMTP_USERNAME=''

SMTP_PASSWORD=''

EMAIL_FROM=''

# Cloudinary account credentials

CLOUDINARY_CLOUD_NAME=''

CLOUDINARY_API_KEY=''

CLOUDINARY_API_SECRET=''

```

## How to run

1. Clone this repository

```bash

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

```

2.  Install dependencies

    Server

    ```bash

    cd server

    yarn

    ```

    Client

    ```bash

    cd client

    yarn

    ```

3.  Run the application

    Server

    ```bash

    yarn dev

    ```

    Client

    ```bash

    yarn dev

    ```

4.  You can optionally build the application

    Server

    ```bash

    yarn start

    ```

    Client

    ```bash

    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

![Login](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113262/learing-platform/screenshots/login_f5o6ew.png)

#### Register

![Register](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113263/learing-platform/screenshots/register_lyk6k2.png)

#### Forgot password

![Forgot password](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113265/learing-platform/screenshots/forgot-password_z1uhrd.png)

### Home

![Home](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113266/learing-platform/screenshots/home_ntq2um.png)

### User

#### Course Access

![Course Access](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113272/learing-platform/screenshots/course_vgsno1.png)

#### Dashboard

![Dashboard](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113265/learing-platform/screenshots/user-dashboard_adu4zh.png)

#### Leaderboard

![Leaderboard](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113262/learing-platform/screenshots/user-leaderboard_lxydyq.png)

#### Profile

![Profile](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113267/learing-platform/screenshots/user-profile_g6hkfz.png)

#### Change password

![Change password](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113268/learing-platform/screenshots/user-change-password_ayclsp.png)

### Admin

#### Dashboard

![Dashboard](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113261/learing-platform/screenshots/admin-dashboard_pr7rsk.png)

#### Videos

##### All videos

![Videos](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113270/learing-platform/screenshots/admin-videos_mttqoe.png)

##### Add video

![Add video](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113266/learing-platform/screenshots/admin-add-video_gegr2k.png)

##### Edit video

![Edit video](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113269/learing-platform/screenshots/admin-edit-video_auszlx.png)

#### View video

![View video](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113268/learing-platform/screenshots/admin-view-video_xujqzx.png)

#### Quizzes

##### All quizzes

![Quizzes](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113267/learing-platform/screenshots/admin-quizzes_hmu9bk.png)

##### Add quiz

![Add quiz](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113267/learing-platform/screenshots/admin-add-quizz_nd3if7.png)

##### Edit quiz

![Edit quiz](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113261/learing-platform/screenshots/admin-edit-quizz_gulutm.png)

#### View quiz

![View quiz](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113263/learing-platform/screenshots/admin-view-quizz_p3vag6.png)

#### Assignments

##### All assignments

![Assignments](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113262/learing-platform/screenshots/admin-assignments_hpdoqf.png)

##### Add assignment

![Add assignment](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113261/learing-platform/screenshots/admin-add-assignment_j13hhn.png)

##### Edit assignment

![Edit assignment](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113264/learing-platform/screenshots/admin-edit-assingment-mark_zku5rh.png)

#### View assignment

![View assignment](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113261/learing-platform/screenshots/admin-view-assignment_rpxf1x.png)

#### Assignments marks

##### All assignments marks

![Assignments marks](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113261/learing-platform/screenshots/admin-assignment-marks_f8ydet.png)

##### Edit assignment mark

![Edit assignment mark](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113264/learing-platform/screenshots/admin-edit-assingment-mark_zku5rh.png)

##### View assignment mark

![View assignment mark](https://res.cloudinary.com/b-l-i-n-d/image/upload/v1692113267/learing-platform/screenshots/admin-view-assignment-mark_pgqoau.png)

## License

[MIT](https://choosealicense.com/licenses/mit/)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/b-l-i-n-d/edtech

Awesome Lists containing this project

README

EdTech
