Skip to content

Commit 0758c6b

Browse files
committed
Warn about database and tests
1 parent 8c20b55 commit 0758c6b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ From this initial state you can:
2222
* update settings to suit your needs
2323
* install more Python libraries and add them to the `requirements.txt` file
2424

25-
2625
## Special files in this repository
2726

2827
Apart from the regular files created by Django (`project/*`, `welcome/*`, `manage.py`), this repository contains:
@@ -35,6 +34,17 @@ openshift/ - OpenShift-specific files
3534
requirements.txt - list of dependencies
3635
```
3736

37+
## Warnings
38+
39+
Please be sure to read the following warnings and considerations before running this code on your local workstation, shared systems, or production environments.
40+
41+
### Database configuration
42+
43+
The sample application code and templates in this repository contain database connection settings and credentials that rely on being able to use sqlite.
44+
45+
### Automatic test execution
46+
47+
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.
3848

3949
## Local development
4050

0 commit comments

Comments
 (0)