jshwelz / movies-search

Backend Api for searching movies on a movies dataset

This project contains a boilerplate for a simple restful api using Flask

Table of Contents

• [Getting Started][1]
  • [Prerequesites][2]
  • [How to Run Backend Server][3]
  • [Run Unit Testing][3]
• [Usage][4]
  • [Authentication Token][5]

Getting Started

The project involves a backend api which contains functionality to returns movies data by pagination and other filters.

Prerequisites

Activate the virtual environment Install the the require packages via pip

python3 -m venv /opt/venv
source venv/bin/activate
pip install -U -r requirements.txt

Running

On the root folder run

flask run

Run Unit Testing

python -m pytest -s tests/test_movies.py

Usage

Usage Both install options expose the backend on [http://127.0.0.1:5000] (http://127.0.0.1:5000), with docs at [http://127.0.0.1:8000/docs])