https://github.com/hs831/socialflix
A backend project which have different APIs for a social media website like Facebook, Instagram, etc..
https://github.com/hs831/socialflix
expressjs jwt-authentication mongodb mongoose nodejs rest-api
Last synced: 3 months ago
JSON representation
A backend project which have different APIs for a social media website like Facebook, Instagram, etc..
- Host: GitHub
- URL: https://github.com/hs831/socialflix
- Owner: HS831
- Created: 2022-05-19T14:17:08.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-09T14:34:21.000Z (about 3 years ago)
- Last Synced: 2025-03-16T01:42:11.323Z (over 1 year ago)
- Topics: expressjs, jwt-authentication, mongodb, mongoose, nodejs, rest-api
- Language: JavaScript
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# SocialFlix
## The APIs you need for any kind of social media websites.
SocialFlix is a backend ready API project built with Node.js, Express.js which supports all the required APIs that is nedded for a social media website.
## APIs List :
- POST api/users/authenticate: Log In
- POST /api/users/follow/{id} : authenticated user would follow user with {id}
- POST /api/users/unfollow/{id} : authenticated user would unfollow a user with {id}
- GET /api/user : authenticate the given user and return the respective user profile.
- POST api/posts/ : would add a new post created by the authenticated user.
- DELETE api/posts/{id} : would delete post with {id} created by the authenticated user.
- POST /api/like/{id} : would like the post with {id} by the authenticated user.
- POST /api/unlike/{id} : would unlike the post with {id} by the authenticated user.
- POST /api/comment/{id} : add comment for post with {id} by the authenticated user.
- GET api/posts/{id} would return a single post with {id} populated with its number of likes and comments.
- GET /api/all_posts : would return all posts created by authenticated user sorted by post time.
## Tech
SocialFLix uses a number of Libraries to work properly:
- Node.js
- Express.js
- mongoose
- For Database : MongoDB
- For authentication : jsonwebtoken
- And many more..
## Installation
SocialFLix requires [Node.js](https://nodejs.org/) v10+ to run.
### Steps to run this project :
```sh
Step 1 : Clone this Repo
Step 2 : Open your bash shell and run code git clone {git clone url}
Step 3 : Install the dependencies and devDependencies and start the server.
Step 4 :
cd socialflix
npm i
npm run dev : For development enviorments
```
The local server will start at 127.0.0.1:3000/