Films api service

This RESTful API service is a part of the training project Cinotes (currently unavailable).

• Full backend repository
• Frontend repository

Technologies used

• Django: The web framework for perfectionists with deadlines
• Django Rest Framework: A powerful and flexible toolkit for building Web APIs
• Docker: Develop faster. Run anywhere
• Docker compose: Tool for defining and running multi-container Docker applications
• PostgreSQL: The world's most advanced open source database
• Amazon S3: Cloud object storage with industry-leading scalability, data availability, security, and performance

Installation

• If you wish to run your own build, first ensure you have installed Python and Docker Desktop (docker engine and docker compose for Linux)

• If everything is installed, clone this repository to your computer:

  git clone https://github.com/TeraBasedProgrammer/films-api-service.git
  

• Setup dependencies

  1. Cd into the project directory

     $ cd films-api-services

  2. Create a python virtual environment

     $ python -m venv env

  3. Activate venv

     • Linux

     $ source env/bin/activate

     • Windows (run the file)

     $ env\Scripts\activate.bat

  4. Install dependencies

     $ pip install -r films/requirements.txt

• Run the application

  • Makefile

  $ make run

  or

  • Docker compose

  $ docker compose up -d

Usage

To see full documentation of the project import films-api-docs.json to your Postman workspace.

License

This project is licensed under GPL v3 license. See file LICENSE.txt.

Contributing

Feel free to contribute to the project. PR are welcome.

Contact

You can reach me in telegram if you need.