Dateflix API

The API for Dateflix APP, the Tinder for Netflix

Postman Collection · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Project developed during live coding session at Twitch. This is a web app to find someone to watch Netflix with you, something similar to Tinder.

The project has two different repositories: the backend API and the frontend website.

Built With

List of the major frameworks this project is using.

• Django
• Django Rest Framework

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

List of things you need to use the software and how to install them.

• Docker

• docker-compose

• postman

Installation

1. Create a Facebook App for Instagram, following this tutorial.
2. Get a API Tokenb for The Movie DB, following this tutorial
3. Clone the repo

git clone https://github.com/pythrick/dateflix-api.git

4. Enter in repository directory

cd dateflix-api

5. Startup project

make init

Usage

1. Run the API

make run

2. Import the Postman collection, following this tutorial.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Patrick Rodrigues - @pythrick - pythrick@gmail.com

Project Link: https://github.com/pythrick/dateflix-api/