README.md

Study App

An awesome study app for students!

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contact
5. Acknowledgements

About The Project

Study App is a platform built for university students to create study groups based on their courses, post questions on a course forums, and live chat with one another.

Built With

• React(.js)
• Express(.js)
• MongoDB
• Node(.js)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

• Create a Cloudinary account
• Create a MongoDB Atlas account

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Study-App.git

2. Install NPM packages in client and server folders

   npm install

3. Create a .env file in the server folder and add the following API keys

    MONGO_URI=YOUR_MONGO_URI
    SECRET_KEY=RANDOM_KEY_FOR_SIGNING_JWT
    CLOUDINARY_CLOUD_NAME=YOUR_CLOUDINARY_NAME
    CLOUDINARY_API_KEY=YOUR_CLOUDINARY_API_KEY
    CLOUDINARY_API_SECRET=YOUR_CLOUDINARY_API_SECRET_KEY

4. Run server

  cd server
  npm run dev

6. Run client

  cd client
  npm start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contact

Ethan Tam - ethan.stewart.tam@gmail.com

Acknowledgements

• Material UI
• Mongoose
• Socket.io
• Express Validator
• JWT
• bcrypt
• Best-README-Teemplate