VidHut

Table of Contents

• About the Project
  • Feature Requests
  • Tech Stacks
• Getting Started
  • Dependencies
  • Installation
• Contributing
• License

About The Project

A platform that operates like a movie streaming platform but for short movies created by college students.

Feature Requests

User: Unauthenticated

• [ ] Visit the platform to view basic information about the platform
• [ ] View and Interact with the documentation
• [ ] Register to view more details
• [ ] No access to use until registered
• [ ] Able to view all available movies

User: Authenticated

• [ ] Full access to the platform
• [ ] Allow upload of short movies (not more than 15 minutes)
• [ ] User must be a verified college student
• [ ] Watch films uploaded by others
• [ ] Comments, react and share movies
• [ ] Show usage example to users
• [ ] Allow user save data and come back to download

Tech Stacks

• Python
• Django
• Bootstrap
• [Add other languages or tools used here]

Getting Started

Dependencies

• Python
• Text editor (e.g VSCode)
• Web browser
• Git

Installation

Follow the steps below to get the program working on your system locally.

1. Clone the repo

   git clone https://github.com/zuri-training/Col_Films_Proj_Team_113.git

2. Change into the directory of the cloned repo

   cd Col_Films_Proj_Team_113

3. Setup a virtual environment

   python3 -m venv venv

4. Activate the virtual environment

   . venv/bin/activate

5. Install the project requirements

   pip install -r requirements.txt

6. Move into the backend folder where the development files reside

   cd backend

7. Create your database migrations

   python manage.py makemigrations
   python manage.py migrate

8. Create a superuser

   python manage.py createsuperuser

   Use the example credentials

   Email: admin@school.edu.ng
   Passsword: schooladminpassword

9. Start the local development server

   python manage.py runserver

10. Visit the URL via the browser

    http://127.0.0.1:8000/

Contributing

Please see the the contributing guide for detailed instructions on how to get started with our project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details