Skip to content

Files

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Latest commit

author
Maxence
Aug 1, 2016
15dead2 · Aug 1, 2016

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 1, 2016
Dec 18, 2015
Dec 14, 2015

Setting up the demo project

A demo project to get you started with DRF docs development.

Installation

From the route of the repository:

# Create the virtual environment
pyvenv env

# Install requirements
env/bin/pip install -r requirements.txt

# Activate the environment
source env/bin/activate

# Cd Into the demo
cd demo/

# Install Django Rest Framework Docs
pip install -e ../

# Run the project
python manage.py runserver

Note: You do not need a database or to run migrate.

Viewing DRF Docs

Once you install and run the project go to http://0.0.0.0:8000/docs/.

Note

The demo project has no functionality at all. Its purpose is only for viewing the docs and developing DRF docs further.