Study App
An awesome study app for students!
Table of Contents
-
About The Project
-
Getting Started
- Demos
- Roadmap
- Contact
- 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
- Clone the repo
git clone https://github.com/your_username_/Study-App.git
- Install NPM packages in client and server folders
npm install
- 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
- Run server
cd server
npm run dev
- 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
- Ethan Tam - ethan.stewart.tam@gmail.com
- Jonathan Quagliariello - jon.quag@gmail.com
- Amha Desta - amha7819@gmail.com
- Ethan Rosenberg - ethan@ethanrosenberg.com
Acknowledgements