search

hatchways / team-dexter

0 stars 4 forks source link

readme

Contributors Forks Stargazers Issues


Logo

Study App

An awesome study app for students!

Table of Contents
  1. About The Project
  2. Getting Started
  3. Demos
  4. Roadmap
  5. Contact
  6. 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

Getting Started

Prerequisites

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
  5. Run client 
    cd client
npm start

    Demos

Creating an account

Chat functionality with sockets

Adding and deleting courses

Adding a photo to the user profile

Adding comments on forum posts

Creating a group for students

Roadmap

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

Contact

  1. Ethan Tam - ethan.stewart.tam@gmail.com
  2. Jonathan Quagliariello - jon.quag@gmail.com
  3. Amha Desta - amha7819@gmail.com
  4. Ethan Rosenberg - ethan@ethanrosenberg.com

Acknowledgements