Metadata-Version: 2.1
Name: boilerplate-django-rest-api
Version: 0.7.0
Summary: A Django app to build REST API
Home-page: https://github.com/ravuthz/django_boilerplate/tree/rest
Author: Ravuthz
Author-email: ravuthz@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
Requires-Dist: constance
Requires-Dist: dj-database-url
Requires-Dist: django-extensions
Requires-Dist: rest-framework
Requires-Dist: rest-auth
Requires-Dist: oauth2-provider
Requires-Dist: corsheaders
Requires-Dist: drf-yasg

# Boilerplate Django Rest API

Django app build with rest api package such as DjangoRestFramework.

Detailed documentation is in the "docs" directory.

### Quick start

1. Add "boilerplate_django_rest_api" to your INSTALLED_APPS setting like this::
```
INSTALLED_APPS = [
    ...
    'boilerplate_django_rest_api',
]
```

2. Include the polls URLconf in your project urls.py like this::
```
path('rest/', include('boilerplate_django_rest_api.urls')),
```

3. Run ``python manage.py migrate`` to create the polls models.

4. Start the development server and visit http://127.0.0.1:8000/admin/
   to test the rest (you'll need the Admin app enabled).

5. Visit http://127.0.0.1:8000/rest/ to test the rest api

