Skip to content

Latest commit

 

History

History
269 lines (186 loc) · 9.12 KB

README.md

File metadata and controls

269 lines (186 loc) · 9.12 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

video-streaming

A manager for playlist's streaming videos in local mode!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

This is a personal project because I love the series and with this I like management the playlists made in local mode

In this project the objetives are:

  • Create a local database with PostgreSQL through Django ORM
  • Use JWT with custom user model
  • Login with email and password
  • Create the REST API for CRUD operations through Django Rest Framework
  • Use Swagger for document the REST API

(back to top)

Built With

  • Python
  • Django
  • DjangoREST
  • Swagger
  • JWT
  • Postgres

(back to top)

Getting Started

Prerequisites

This project use a postgreSQL local database.

Installation

  1. Clone the repository

    git clone https://github.com/mikelm2020/video-streaming.git

  2. Create the python virtual enviroment

  3. Prepare the virtual enviroment through of local requirements file in the requirements folder

    pip install -r requirements/local.txt

  4. Create a JSON file with enviroment variables in the video_streaming folder

  5. The enviroment variables are used in the settings

(back to top)

Usage

In the next link can you use the API, the indications are:

  1. Login with the email: jonas@gmail.com and password: Lafrancia
  2. Copy token
  3. Click in authorized button
  4. Paste token in value field
  5. Click in Authorize button
  6. Click in close button
  7. Can you use the API
  8. Logout with refresh-token
  9. Copy refresh-token from response of login
  10. Paste refresh-token in request body of logout

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add CRUD operations
  • Terminate swagger documentation
  • Add versioning control

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Miguel Angel López Monroy - @miguellopezmdev - miguel.lopezm.dev@gmail.com

Project Link: https://service-streaming.onrender.com/

(back to top)

Acknowledgments

My favorite resources used:

(back to top)