Quickstart¶
Prerequisites¶
- Python ≥ 3.6
- Django ≥ 2.2
- PostgreSQL ≥ 9.4
Installation¶
- Install django-crosswalk.
$ pip install django-crosswalk
- Add the app and DRF to
INSTALLED_APPS
in your project settings.
# settings.py
INSTALLED_APPS = [
# ...
'rest_framework',
'crosswalk',
]
- Include the app in your project’s URLconf.
# urls.py
urlpatterns = [
# ...
path('crosswalk', include('crosswalk.urls')),
]
- Migrate databases.
$ python manage.py migrate crosswalk
- Open Django’s admin and create your first API users on the crosswalk
ApiUser
model.
- Install the client.
$ pip install django-crosswalk-client
- Read through the rest of these docs to see how to interact with your database using the client.