NTUAFLIX

Introduction

Unlock Infinite Entertainment with NTUAFLIX: Your Gateway to Movies and Series Extravaganza! Immerse Yourself in a World of Blockbusters and Binge-Worthy Delights. Join the Streaming Revolution Now! #NTUAFLIX #Movies #Series #StreamingExcellence

Access NTUAFLIX here.

Tech Stack

Quick start (docker)

Just run:

docker compose up --build

The frontend will be served on port 5000 and the API on port 8000.

Manual setup

Prerequisites

1. Python , pip
2. Node.js and npm
3. DBMS: PostgreSQL

Quick Setup for Virtual Environment

Make .venv

python3.10 -m venv .venv

Activate .venv

For Windows

.venv\Scripts\activate

For Unix/MacOS

source .venv/bin/activate

Install Dependencies

pip install -r back-end/requirements.txt

Additional if you use MySQL

pip install pymysql

Quick setup for frontend

npm install

Local App Demo

1. Create back-end/.env file to configure your database credentials, check the .env template in back-end/README.md.

2. Add the following parameters for the authentication schema in the .env file you just created:

   SECRET_KEY=469155679be5db1afdb6613292c4c7805dfa71d2be7fde22d5abb522d6f23ef2
   ALGORITHM=HS256
   FORGET_PWD_SECRET_KEY=658955679be4fr3afdb6613292c4c7805dfa71d2be7fde2297abb535d6f23ef2
   

3. Create a database in your DBMS, for example ntuaflix and save the name in the back-end/.env. For the next steps your DBMS should be running (on localhost).

4. Run back-end/models.py to create tables of the schema.

5. Place tsv files for data import into a folder back-end/truncated_data

6. Run back-end/input_tsv.py to import data into the database from the tsv files.

7. Run back-end/main.py to run the back-end code.

8. Run back-end/mock_data_parser.py in a new terminal to insert mock data in the database for a full app expierence demo.

9. While back-end/main.py is running, open a new terminal and run npm start in front-end/ folder to start the front-end.

CLI Client

Quickstart

To install the cli-client you can use the prebuilt wheel package (.whl) you can find in `cli-client/dist/'. Just run:

pip install WHEEL_FILE

You can then immediately run the cli:

ntuaflix-cli [OPTIONS]

Further documentation for the cli client can be found here.

Manual run

If you want to manually run the cli client enter the folder cli-client/ and run:

python3 -m ntuaflix_cli [OPTIONS]

(you may as well use the ntuaflix\_cli.sh [OPTIONS] which does exactly that.

Testing

1. To test the backend enter backend/ and run:

pytest

It will create a testing instance of PostgreSQL (not just a testing db, but a whole dbms). If you want to use your own dbms instance, use the option --use-existing-dbms yes

Because the upload of the data is generally slow, it is not by default tested. Instead we preload a prebuilt test.sql file to the database. If you want to test the upload of the data, use the option --preload no.

2. To test the cli client ebter cli-client/ and run:

pytest

The cli client testing requires a working API (this is not setup by the test, it has to be running; that's because generally the API would be served on a Server, and the cli client would be independently tested). We advise you to firstly test the API, to make sure there are no issues. If the API tests fails, with very high probability the cli client tests will also fail.

What's more, code coverage of the tests can be shown. You can add the option --cov=. if you want to do so.