Giter VIP home page Giter VIP logo

review-api's Introduction

Reviews API

Reviews API collects users feedback on titles from different categories: books, music, films. Users can leave their text reviews and leave comments under others reviews.

Stack

  • Django
  • Django Rest Framework
  • Django Simple JWT
  • django-filter
  • Docker

Setup

Clone the repository and build the docker container.

docker build -t web .

Run container with project. Migrations will be automatically created.

docker run -d --rm web

Create superuser.

docker exec <CONTAINER_ID> python manage.py createsuperuser

Run tests.

docker exec <CONTAINER_ID> pytest

API

API documentation is available at 127.0.0.1/redoc

User registration algorithm:

  • Send request with email and username fields to /auth/email/

  • API will send your confirmation code to your email. For testing purposes django console.Email backend is used. Your confirmation code will be printed in console

  • Send request to /auth/token/ with your email and confirmation_code

API Resources

  • AUTH - user authentication
  • USERS - registered users
  • TITLES - available titles in api
  • CATEGORIES - available categories in api
  • GENRES - available genres in api
  • REVIEWS - users reviews
  • COMMENTS - users comments

review-api's People

Contributors

seergeyl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.