A social network for movie enthusiasts
The CineFriends Project is a project developed by the SKG.CODE Deadpool Team, while participating in the SKG.CODE program.
The social network website developed under the CineFriends project is named "Binge".
This project uses the MERN software stack. The MERN stack is a Javascript stack that is used for easier and faster deployment of full-stack web applications.
MERN stands for MongoDB, Express, React, Node, after the four key technologies that make up the stack.
- MongoDB - document database
- Express(.js) - Node.js web framework
- React(.js) - a client-side JavaScript framework
- Node(.js) - the premier JavaScript web server
For more information check out https://www.mongodb.com/mern-stack.
To run this project locally we have created a BASH script. This script installs all the required dependencies and starts both the backend (accesible from http://localhost:8080/api/) and frontend (accesible from http://localhost:3000) of this project.
You need to have npm installed for the script to run properly.
To see how to run the script run ./run-app.sh or ./run-app.sh -h on a terminal in the same directory where the script is saved.
If you leave the script file in the same directory as on this repository, then simply run ./run-app.sh -p ..
After runnining the script for the first time, which might take a few minutes due to the installations, you can comment out
lines 42 and 56 of run-app.sh, which have the npm install command.
Important: There are 2 .env files (with environment variables) that our project uses, which are not on the repository for security reasons. In order for the project to run properly, you have to create your .env files in the same directories that the .env.example files (examples of how our .env files look like) are present in this repository (in CineFriends/backend and in CineFriends/frontend).
The project's API documentation can be found online on https://binge-cinefriends.herokuapp.com/api/ or http://localhost:8080/api/ if you are running the project locally.
Until November 20, 2020, this project will be solely maintained by the SKG.CODE Deadpool Team.