README.md

tom-demoapp

tom-demoapp is a Django app that serves as a demonstration and code example for a tomtoolkit app. This app contains all of the integration points and features that a TOM developer can use in their custom TOM project.

Detailed documentation can be found in the tomtoolkit docs.

Quick start

1. Add "tom_demoapp" to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [ ..., "tom_demoapp", ]

2. Paths should be automatically included via tom_common.

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

4. Start the development server and visit your tom to see any changes.

App Testing

To incorporate the app testing suite:

1. copy the demoapp testing directory into your app

2. edit the APP_NAME in boot_django.py to match your app name

3. run tests:

   python <<app_name>>/tests/run_tests.py

4. To run canary tests, add the --canary flag, and running individual tests at various levels of verbosity is also supported. (use --help for more information)

5. Update your testing workflows as appropriate.

For development and testing in a shell, you can run:

python <<app_name>>/tests/django_shell.py