/MyView

MyView is an online video sharing platform currently in development using FastAPI at its core.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause


Logo

MyView is an online video sharing platform built using FastAPI

Live Website »


Explore the docs »

Report Bug · Request Feature

github workflow  github workflow  Build Status  Python 3.9  Documentation Status codecov

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Acknowledgments

About The Project

STATUS: Production

Logo

MyView is an online video sharing platform currently in development using FastAPI at its core. A full list of our tech stack is available at our documenations. Here's a link

(back to top)

Built With

Property Tech
Backend FastApi Python
Frontend Javascript  JQuery Bootstrap  Reactjs
Database PostgreSQL
Production Server Heroku
Storage Amazon S3
CI/CD AzurePipelines  GithubActions
Documentation ReadTheDocs

(back to top)

Getting Started

To get started on this project. To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Create a virtual environment

    python -m venv myview_env

  2. Activate virtual environment

    Linux:

    source myview_env/bin/activate

    Windows:

    myview_env\scripts\activate

Installation

  1. Clone the repo 
    git clone https://github.com/prithvijitguha/MyView.git
cd MyView
  2. Install requirements 
    pip install -r requirements.txt
  3. Run the project locally 
    uvicorn main:app --reload

(back to top)

Roadmap

  • Basic Backend
  • Basic Front End
  • Azure Pipelines
  • Github Actions
  • Development
    • Login
    • Upload Video
    • Connect File Storage
    • Setup Development Database
    • Setup Project Templates
    • Playing Video Function
    • Homepage
    • Comment Section
  • Staging
    • Style Improvement:
      • Video Page
      • Homepage
      • Upload
    • Test Coverage - 85%
  • Production
    • Setup Production Database
    • Production Server
    • Production pipeline 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!

Full contributing guide for documentation

Full contributing guide for codebase

(back to top)

Acknowledgments

(back to top)