/drf-example

Project showcasing the capabilities of the Django REST Framework

Primary LanguagePython

Django REST Framework Example

This project is intended to showcase the capabilities of the Django REST Framework with a minimal amount of code.

Wiki

Read the wiki for a complete project breakthrough and explanation.

Or, if you can figure it out for yourself, follow the steps below !

Getting started

  1. First, clone this repository:
    • git clone https://github.com/athento/drf-example
    • cd drf-example
  2. Create a Python virtual environment, this step is optional, but recommended:
    • pip install virtualenv
    • virtualenv env
    • source ./env/bin/activate
  3. Install the dependencies:
    • pip install -r requirements.txt
  4. Run database migrations:
    • python manage.py migrate
  5. Create a superuser:
    • python manage.py createsuperuser
  6. Run the server:
    • python manage.py runserver
  7. Browse the live example. Available URLs:
  8. Read the wiki:

Images

api

method

docs