Giter Club home page Giter Club logo

django-drf-api's Introduction

Django Rest Framework API

This is Python REST API that calls an external API service to get information about books. Additionally, it implements a simple CRUD (Create, Read, Update, Delete) API with a local sql database.

Compatibility

This project is developed and tested with python2.7

Prerequisites

In order to setup this project, make sure you have python's pip package installed on your system.

FYI

You should run all make commands described below on your local machine, within virtualenvs.

Getting Started

  1. Clone the Reop in your local machine.

    git clone https://github.com/awaisdar001/Django-DRF-API.git
    
  2. Create a virtualenv and activate it.

    virtualenv venv
    source venv/bin/activate
    
  3. Install the requirements inside of a Python virtualenv.

    make requirements
    
  4. Run migrations and setup the database locally.

    make update_db
    
  5. [Optional] Create a superuser to get admin access to add/update data manually

    make create_su
    
  6. Run tests and verify everything has setup correctly.

    make test
    
  7. Generate books data in local database.

    make generate_books
    
  8. Run the development server

    make dev.up
    
Service URL
External Books API http://localhost:8080/api/external-books
Books API http://localhost:8080/api/v1/books/
API Admin http://localhost:8080/admin

django-drf-api's People

Contributors

awaisdar001 avatar dependabot[bot] 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.