From 0758c6baefa8785b3f42978890edede50e838a21 Mon Sep 17 00:00:00 2001 From: Corey Daley Date: Mon, 27 Mar 2017 16:46:07 -0400 Subject: [PATCH] Warn about database and tests --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9944765..f0d8194 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ From this initial state you can: * update settings to suit your needs * install more Python libraries and add them to the `requirements.txt` file - ## Special files in this repository 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 ``` +## 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