Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 806 Bytes

README.md

File metadata and controls

34 lines (21 loc) · 806 Bytes

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.