https://github.com/bryanbill/showtime-api
API for the ShowTime App
https://github.com/bryanbill/showtime-api
Last synced: about 1 year ago
JSON representation
API for the ShowTime App
- Host: GitHub
- URL: https://github.com/bryanbill/showtime-api
- Owner: bryanbill
- Created: 2021-05-01T13:12:19.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-10-15T12:59:03.000Z (over 4 years ago)
- Last Synced: 2025-02-17T07:44:59.199Z (over 1 year ago)
- Language: JavaScript
- Homepage: zone-api.vercel.app
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Showtime RESTful API - YouTube Clone
> Showtime is a YouTube clone built with nodejs, expressjs & mongodb.
## Features
> CRUD (Create, Read, Update And Delete)
- Authentication with JWT (Reset Password with email)
- Login (User/Admin)
- Register
- Forgot Password
- Pagination and search where necessary
- API Security (NoSQL Injections, XSS Attacks, http param pollution etc)
- Video (CRUD)
- Upload video
- Upload video thumbnail
- Watch video
- Increase Views
- Like and dislike video
- Download video
- Comment & reply for video
- Update video details
- Delete video
- Subscribe to a channel
- View liked videos
- Trending
- Subscriptions
- History (CRUD)
- Watch history
- Search history
- Settings
- Modify channel name and email
- Change password
- Upload channel avatar
## Frontend Repo
Frontend was developed with vue js and vuetify [VueTube](https://github.com/techreagan/vue-nodejs-youtube-clone)
## API Documentation
Hosted on netlify: [Coming Soon]()
Extensive and testing documentation with postman: [VueTube API](https://documenter.getpostman.com/view/9407876/SzYaVdtC?version=latest)
## Database Model
Though the diagram uses sql data type, this diagram is to show you the various collections in the mongo database.
## Requirement
- NodeJS
- MongoDB
## Configuration File
Rename the config/.env.example to .env, then modify to your environment variables, mongodb uri, set your JWT_SECRET and SMTP variables
```ENV
NODE_ENV=development
PORT=3001
MONGO_URI=YOUR_URL
JWT_SECRET=YOUR_SECRET
JWT_EXPIRE=30d
JWT_COOKIE_EXPIRE=30
FILE_UPLOAD_PATH = ./public/uploads
MAX_FILE_UPLOAD = 1000000
SMTP_HOST=smtp.mailtrap.io
SMTP_PORT=2525
SMTP_EMAIL=
SMTP_PASSWORD=
FROM_EMAIL=noreply@quizapp.com
FROM_NAME=QuizzApp
```
Email testing: use mailtrap for email testing, it's easy no stress.
## Installation
Install all npm dependecies
```console
npm install
```
Install nodemon globally
```console
npm install -g nodemon
```
### Note
Make sure you run the seeder to get categories in your database or Create a user with the role admin, then add category with the category endpoint.
Run database seeder
- Seeder folder is \_data/
- Edit the seeder file if you want to
```console
node seeder -i
```
Delete all data
```console
node seeder -d
```
## Start web server
```console
node run dev
```
## Screenshots
> Delete the screenshot folder if you download this code (Screenshots folder is 3.14mb in size).
### Sign In
### Sign Up
### Home Page
### Watch Page
### Upload Thumbnail Modal
For more screenshots check out the vue frontend repo [VueTube](https://github.com/techreagan/vue-nodejs-youtube-clone)
## License
This project is licensed under the MIT License
## Developed by Reagan Ekhameye (Tech Reagan)
Reach me on twitter [@techreagan](https://www.twitter.com/techreagan)