Giter VIP home page Giter VIP logo

django-rest-framework-boilerplate's Introduction

Django Rest API Boilerplate

A simple REST API boilerplate with custom User model and token authentication. Tested and built with Django 2.1.7 and Django REST Framework.

Project Structure


. django-rest-framework-boilerplate
├── app
│   ├── config
│   │   │── __init__.py
│   │   │── settings.py
│   │   │── urls.py
│   │   └── wsgi.py
│   ├── users
│   │   │── management
│   │   │   │── commands
│   │   │   │  │── __init__.py
│   │   │   │  └── wait_for_db.py
│   │   │   └── __init__.py
│   │   │
│   │   │── migrations
│   │   │   └── __init__.py
│   │   │
│   │   │── tests
│   │   │   │── __init__.py
│   │   │   │── test_admin.py
│   │   │   │── test_commands.py
│   │   │   │── test_models.py
│   │   │   └── test_users_api.py
│   │   │
│   │   │── __init__.py
│   │   │── admin.py
│   │   │── apps.py
│   │   │── models.py
│   │   │── serializers.py
│   │   │── urls.py
│   │   └── views.py
│   │
│   ├── .flake8
│   ├── db.sqlite3
│   └── manage.py
├── .gitignore
├── README.md
├── requirements.txt

Installation

Cloning the repository in your virtualenv:

$ git clone https://github.com/olivrg/django-rest-framework-boilerplate.git

$ cd django-rest-framework-boilerplate

Install dependancies:

$ pip install -r requirements.txt

Make migrations & migrate

$ python manage.py makemigrations && python manage.py migrate

Create super user

$ python manage.py createsuperuser

Launching the app

$ python manage.py runserver

Create a new user

Go to: http://127.0.0.1:8000/api/user/create/

Run Tests

$ python manage.py test

Contributing

Contributions, questions and comments are welcome and encouraged.

License

MIT License.

django-rest-framework-boilerplate's People

Contributors

olivrg avatar

Watchers

 avatar  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.