eduardo-lemes / irontube-api Goto Github PK

# IronTube Api

IronTubeApi is a express rest api where you can upload your videos, comment and learn from other users.
Created by: Eduardo Lemes, Anderson Lucas

## Features

- Upload videos
- Add Comments on videos

## Tech
- .[node.js].
- .[express].

## Installation

Clone this repo

In the source folder add an .env file with this variables:

MONGO_URI - for your atlas cluster or local mongodb
TOKEN_SECRET - for your jwt secret
EXPIRATION_AUTH_TOKEN - for setting your expiration time for jwt

Install the dependencies and devDependencies and start the server.

```sh
npm i
npm run dev
```
**`http://localhost:5000/api`**.

You can test with:
**`https://rest-api-irontube.herokuapp.com`**


The common endpoints are the following:

| Method | Endpoint                  | Payload                                    | Response              | Action                                                         |
| ------ | ------------------------- | ------------------------------------------ | --------------------- | -------------------------------------------------------------- |
| POST   | /auth/signup              | {"username":String, "password:String",}    | -                     | Return JWT to private routes                                   |
| POST   | /auth/login               | {"username":String,"password":String}      | Auth JWD              | Create new user                                                |
| GET    | /videos/list/             | -                                          | {video}               | Get all videos form the DB                                     |
| GET    | /videos/view/:id          | -                                          | {video}               | Get video details                                              |                               
| POST   | /videos/upload            | {"title": String, "description":String}    | {video}               | Post video on  DB                                              |