X-dark/django-ex
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #83 from coreydaley/github_58_notes_in_docs_about_tests

Browse source 
Warn about database and tests
This commit is contained in:
Ben Parees 2017-03-29 11:34:38 -04:00 committed by GitHub
commit ce8bc24339
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -22,7 +22,6 @@ From this initial state you can:
* update settings to suit your needs * update settings to suit your needs
* install more Python libraries and add them to the `requirements.txt` file * install more Python libraries and add them to the `requirements.txt` file
## Special files in this repository ## Special files in this repository
Apart from the regular files created by Django (`project/*`, `welcome/*`, `manage.py`), this repository contains: Apart from the regular files created by Django (`project/*`, `welcome/*`, `manage.py`), this repository contains:
@ -35,6 +34,17 @@ openshift/ - OpenShift-specific files
requirements.txt - list of dependencies requirements.txt - list of dependencies
``` ```
## Warnings
Please be sure to read the following warnings and considerations before running this code on your local workstation, shared systems, or production environments.
### Database configuration
The sample application code and templates in this repository contain database connection settings and credentials that rely on being able to use sqlite.
### Automatic test execution
The sample application code and templates in this repository contain scripts that automatically execute tests via the postCommit hook. These tests assume that they are being executed against a local test sqlite database. If alternate database credentials are supplied to the build, the tests could make undesireable changes to that database.
## Local development ## Local development