/StudySpace

Primary LanguageJavaScriptMIT LicenseMIT

StudySpace 🧠

StudySpace is a social networking-based platform for the purpose of gathering individuals from the same areas of study or same class across the whole internet. They do not have to come from the same school or the same city, but they belong in the same community because of the class they are currently enrolled in. It's a place where people can motivate each other, answer each's questions, seek help from others, and even do work together virtually. It's a perfect application to boost one's productivity, learning experience, and make new friends.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To run this application locally on your computer, you'll need Git and Node.js (which comes with npm) installed on your computer.

Installing

Then run the following command in the command line and go to the desired directory to store this project:

Clone this repository

git clone https://github.com/ivy118/StudySpace.git

Go into the repository

cd StudySpace

Install all dependicies

npm install

Go into the front-end folder

cd frontend

Install all dependicies

npm install

Go into the backend-end folder

cd ../backend

Install all dependicies

npm install

Go back to the root directory

cd ..

Run the app

npm run dev

Built With

  • React - Front-end library used to built the user interface
  • Express - Web framework for Node.js for the back-end
  • ElephantDB - For relational database (PostgreSQL)
  • AWS S3 - For image storage

Contributing

All issues and feature requests are welcome. Feel free to check the issues page if you want to contribute.

Authors

License

This project is MIT licensed.