|---------------------------------------------| |hackoregon_sandbox|
[](https://badge.fury.io/py/2019-sandbox-backend)
[](https://travis-ci.org/hackoregon/2019-sandbox-backend)
2019 Sandbox backend API
Documentation
The full documentation is at <http://hackoregon.github.io/>2019-sandbox-backend
Features
- TODO (add what your project does)
Data Sources
Quickstart to install package in your own Django Project (Non-Hack
Oregon Workflow)
Install hackoregon_sandbox:
pip install hackoregon_sandbox
Add subpackages to your INSTALLED_APPS:
`` ` python INSTALLED_APPS = ( ... 'api', ... ) ```
Add hackoregon_sandbox's URL patterns:
`` ` python from hackoregon_sandbox.api import urls as api_urls urlpatterns = [ ... url(r'^', include(api_urls)), ... ] ```
Setup your database with a matching schema
Run the project
Running Tests
This repo uses pytest and pytest-django to run tests.
For project development work, tests will be run in docker container using the bin/test.sh script:
Credits
Tools used in rendering this package:
