An open API service indexing awesome lists of open source software.

https://github.com/oflore12/where-to-stream

This is the repository for the project
https://github.com/oflore12/where-to-stream

Last synced: 4 months ago
JSON representation

This is the repository for the project

Awesome Lists containing this project

README

          

# Where To Stream (CMSC447Project)
This is the repository for CMSC447 Project.

Install and run the project, the *run.sh* bash script should work with sudo privileges:

- `sudo bash run.sh`

The bash script follows the below installation and usage instructions.

## Installation
To install packages needed for Python and Flask, run these commands:

- `sudo apt install -y python3-pip build-essential libssl-dev libffi-dev python3-dev python3-venv postgresql postgresql-contrib`

Make sure you're in the CMSC447Project directory and create a new virtual environment:

- `python3 -m venv env`

To activate environment, make sure you're in the CMSC447Project directory and run:

- `source env/bin/activate`

Once you see (env) prior to your username in the terminal, run:

- `pip install -r requirements.txt`

Start the PostgreSQL database:

- `sudo passwd postgres` (1st time after install)
- `sudo service postgresql start`

New way to create the PostgreSQL user and database:

- `sudo -iu postgres createuser -P -e -s wts`
- Enter password `team3` and confirm password
- `python3 init_db.py`

To run Flask application

- `export FLASK_DEBUG=1`
- `flask run`

In the machine running flask, open a web browser and go to http://127.0.0.1:5000/. You should be able to see the web page.

## Usage
- `source env/bin/activate`
- `sudo service postgresql start`
- `python3 init_db.py`
- `export FLASK_DEBUG=1`
- `flask run`

## Testing
In the Python environment, simply run `pytest` to run a test session on all testing files. All testing files are located in the *tests/* directory.

To run a specific testing file, run `pytest test/.py`.