https://github.com/kimlimjustin/classroom

A website similar to Google Classroom created using the MERN stack.
https://github.com/kimlimjustin/classroom

clone-website express-js expressjs google-classroom google-classroom-clone mern mongodb nodejs react

Last synced: 2 months ago
JSON representation

A website similar to Google Classroom created using the MERN stack.

• Host: GitHub
• URL: https://github.com/kimlimjustin/classroom
• Owner: kimlimjustin
• License: mit
• Created: 2020-10-21T04:20:35.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-26T08:22:12.000Z (over 2 years ago)
• Last Synced: 2024-10-03T08:30:07.276Z (3 months ago)
• Topics: clone-website, express-js, expressjs, google-classroom, google-classroom-clone, mern, mongodb, nodejs, react
• Language: JavaScript
• Homepage:
• Size: 686 KB
• Stars: 37
• Watchers: 3
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Classroom

![Classroom demo](https://drive.google.com/uc?esport=view&id=14Iu2VRcHoCKUCUkF0iMCuyjcj9_TZ90a)

#### Warning: although this project has some basics security such as hashed user password and others, this project is NOT secure enough in production. (Contribute to this project by making a pull request will be appreciated)

How to run:

- Clone this repository or fork it.

  `git clone https://github.com/kimlimjustin/Classroom.git` or `git clone https://github.com//Classroom.git`

- Inside `server` folder, create a new file called `.env` which stores your `ATLAS_URI`, `SECURITY_KEY` and `CLIENT_URL` information

  - store your database URI inside `ATLAS_URI` variable

  - store your security key inside `SECURITY_KEY` variable

  - store your client url inside `CLIENT_URL` variable

  - example:

  ```

  ATLAS_URI =mongodb+srv://admin:@cluster0.8aezk.gcp.mongodb.net/classroom?retryWrites=true&w=majority

  SECURITY_KEY = D73373D9B4ED6FEC5B8B2DAF6WA929B1C7D14CDC88B196EBDCCEA77AFF7BB9

  CLIENT_URL = http://localhost:3000/

  ```

- Inside `client` folder, create a new file called `.env` which stores your `REACT_APP_SECURITY_KEY` and `REACT_APP_BACKEND_URL` informations

  - store your security key inside `REACT_APP_SECURITY_KEY` variable, note that this value must same as `SECURITY_KEY` in `server/.env` file

  - store your server url inside `REACT_APP_BACKEND_URL` variable

  - example:

  ```

  REACT_APP_SECURITY_KEY = D73373D9B4ED6FEC5B8B2DAF6WA929B1C7D14CDC88B196EBDCCEA77AFF7BB9

  REACT_APP_BACKEND_URL = http://localhost:5000

  ```

- install all dependencies.

  - Client side:

    on the `client` directory type `npm install`

  - Server side:

    on the `server` directory type `npm install`

- Run it on node js:

  - Client side:

    on the `client` directory type `npm start`

  - Server side:

    on the `server` directory type `npm start`