Giter Club home page Giter Club logo

team-118-col-films's Introduction

COREELS Project Documentation {intro}

A short movie streaming platform developed by Team 118 of Zuri/I4G Training Participants Movies are uploaded only by Verified College students but can be streamed by anyone from anywhere around the world as long as they're signed into their COREELS account.

Installation {installation}

The project is built and deployed with Django and below are instructions on how to set it up and run it locally on your system.

  1. Clone a Copy of the Project. Clone a copy of the project from GitHub or extract the zipped archive into a directory on your computer where you can easily access it.

  2. Download and Install Python 3

    • Go to Python and install it on your computer.
    • Open your terminal and type python --version. If you see output similar to Python 3.10.4 then you have successfully installed python.
  3. Create a Virtual Environment

    • Open a terminal and cd into the folder/directory where you cloned your copy of the COREELS project into.
    • Run python -m venv venv to create a virtual environment for your project.
    • Once your virtual environment has been created, run venv/scripts/activate (Windows users) OR source venv/bin/activate (Linux/Unix-like users).
    • If everything goes well, your terminal prompt will be prepended with venv.
  4. Install Required Packages Now that python and virtual environemnt is set up;

    • Run where.exe python (Windows users) OR (Linux/Unix-like users) on your terminal. If everything works well so far, you should see output similar to below output on your terminal.

      C:\Festus\Codes\Organisations\Zuri\coreels\venv\Scripts\python.exe
      C:\Users\FESTUS\AppData\Local\Programs\Python\Python310\python.exe

      Where each of the output line is a path to executabe python file.

    • Now install required python packages by running: pip install -r requirements.txt.

    • This command will install all the required packages that have been listed in our requirements.txt file.

How To Use {how-to}

Follow below steps to run the project and test how it works.

  1. Ensure you're in same location as the file manage.py and that your virtual environemnt is still activated.
  2. Type python manage.py migrate.
  3. If everything works as it should, django will use migrations file in the project apps and create a new (sqlite3) database in the same location as manage.py file.
  4. Create a superuser account by running: python manage.py createsuperuser command on the terminal. Provide desired username, email address, password and password confirmation as being prompted.
  5. Next, run python manage.py runserver. This will start a development server on localhost on port 8000 which can be accessed via: http://127.0.0.1:8000/

That is all. You can now visit above address to see the content of the website and start playing around with the functionalities.

Developers {developers}

This project was built, developed and deployed by Team 118 of Zuri/I4G training participants. The project idea was from Zuri.

License {license}

The code is MIT licensed. To understand your rights, privileges and limitations better, please refer to the LICENSE.

Thanks & Credits {credits}

We sincerely appreciate the organizers of this training (I4G/Zuri) and their partners for giving us the opportunity to participate and learn from the best teams, tutors and mentors all for free.

team-118-col-films's People

Contributors

eche3 avatar festusali avatar jemimaameobi avatar jeremiahlateef avatar nsikanpatrick avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

team-118-col-films's Issues

work on the user research and design

The tasks below were assigned to @Eche3

Each task links to an issue that gives more details about what @Eche3 has done.

  • Work on the user research
  • Work on the empathy map
  • Work on the user flow
  • Work on the feature list
  • Work on high-fi screen player page desktop version
  • Work on high-fi screen player page mobile version
  • Work on low-fi screen player page desktop version

Please see comments below for links to the tasks I worked on.

Tasks Assigned to Nthabiseng Matjama (Team Member)

The tasks below were assigned to @Nthatha

Each task links to an issue that give more details about what @Nthatha has done.

  • Formulate ideas on the research plan
  • Work with the team on the empathy map
  • Work on the user research
  • Worked on Mission and Vision Statement

Please see comments below for links to the tasks I worked on.

Desktop and mobile profile pages for Coreels website

create the logo for the project

The tasks below were assigned to @MeeshaAisha

Each task links to an issue that gives more details about what @MeeshaAisha has done.

  • Create the Logo for the project
  • Design mobile terms and conditions page
  • Design desktop terms and conditions page
  • Design Mobile Password recovery page
  • Design Desktop Password recovery page
  • Worked on the color scheme

Please see comments below for links to the tasks I worked on.

Tasks Assigned to Dolapo Oyewole (Team Member)

The tasks below were assigned to @diamondright

Each task links to an issue that gives more details about what @diamondright has done.

  • Worked on user research
  • Designed the affinity map
  • Designed the user personas and stories
  • Worked on the user flow
  • Worked on the research plan
  • Suggested a name for the project with @Festusali
  • Designed low-fidelity and high-fidelity (explore page and trending page) for the web and its mobile responsiveness.

Please see comments below for links to the tasks I worked on.

Implement Basic Project Structure

Bootstrap project basic structure

  • Add database models/tables
  • Create views
  • Add URLs
  • Create template structure
  • Placeholder templates for common pages across the site
  • Make the project ready to deploy.

Tasks Assigned to FyreStark1 (Team Member)

The tasks below were assigned to @FyreStark1

Each task links to an issue that give more details about what @FyreStark1 has done.

  • Build the lofi of the about us page
  • Build the hifi of the about us page
  • Collaborate on the design for the logo
  • Build the desktop screens for both lofi and hifi
  • Build the mobile screens for both lofi and hifi

Please see comments below for links to the tasks I worked on.

Carry out user research

  • Work on the empathy map.
  • Work on the user research.
  • Research the user feedback.
  • Documentation along side with some team members
  • Carried out competitive analysis
  • Brainstormed features and pain points

Tasks Assigned To Nsikan Patrick (Team Member)

The tasks below were assigned to @NsikanPatrick

Each task links to an issue that gives more details about what @NsikanPatrick has done.

  • Allow all users to view the different videos on the platform
  • Restrict upload functionality to only registered and logged users
  • Restrict video editing and deleting features to only the user that posted it
  • Map registered users to the videos they uploaded such that if their accounts get deleted, all their videos get deleted among
  • Updated relevant backend scripts to allow a full integration of postgresql on the app.

Above is a summary of what @NsikanPatrick worked on

build the sign-up page

  • build the mobile screen for the sign-up page.
  • build the desktop screen for the sign-up page.

Create tasks.md file

#Create A File Used To Track Members Contributions

Create a file named tasks.md that team members can modify to include the tasks they worked.
In the file, give them a simple guide on how to modify the file in other not to override another user's contributions too.

Tasks Assigned to ADANNAIYA (Team Member)

The tasks below were assigned to @ADANNAIYA

Each task links to an issue that gives more details about what @ADANNAIYA has done.

  • Work on the research plan
  • Provide quantitative analysis to the research team
  • Provide qualitative analysis to the research team
  • Work on the affinity map
  • Work on the empathy map

Please see comments below for links to the tasks I worked on.

build the login page

  • build the mobile screen for the login page
  • build the desktop screen for the login page

FRONTEND: Build the frontend six pages for the project

  • build the mobile and desktop screens of the FAQs page.
  • build the mobile and desktop screen of the landing page.
  • build the mobile and desktop screens of the trending page.
  • build the mobile and desktop screens of the explore page.
  • build the mobile and desktop screens of the login page.
  • add JavaScript functionality to the inputs in the sign-up page and the login page.

Tasks Assigned to Adetoke (Team Member)

The tasks below were assigned to @Adetoke

Each task links to an issue that give more details about what @Adetoke has done.

  • Worked on the research plan
  • Worked on the figjam file
  • Made contribution to the research plan
  • Worked on the presentation that is submitted to the Zuri team with the team lead @jemimaameobi

Please see comments below for links to the tasks I worked on.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.