aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/README.md b/README.md
index b5775fe..6e11599 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Most of the features are here and the application should fulfill the use
case at this time.
-Things to fix/add going forward:
+## Things to fix/add going forward:
* Friendly Error pages
* Description format field for customer objects &
@@ -16,14 +16,37 @@ Things to fix/add going forward:
* Figure out if auditlog timestamps are fucked or not with timezones
-To get a development system setup:
+## To get a development system setup:
+Not strictly part of the Django app, but worth noting that if you have
+Postgres installed locally but don't want to muck with permissions, service
+etc it's as simple as:
+
+```bash
+pg_ctl -D pg_data initdb
+pg_ctl -D pg_data -l pg_log start
+echo create database $(id -un)\; | psql postgres
+```
+
+Your user should be able to connect with just a simple `psql`
+
+You will need to install
+
+```
+base-devel
+python3-devel
+postgresql-libs-devel
+```
+
+On Void Linux. On Ubuntu machines it will be similar.
``` bash
cd app
virtualenv env
. env/bin/activate
pip install -r requirements.txt
+cp config-example.yml config.yml
+sed -i.bak -e"s/USER: postgres$/USER: $(id -un)" config.yml
./manage.py migrate
./manage.py createsuperuser
# This will create some fake records if you wish
@@ -37,7 +60,7 @@ pip install -r requirements.txt
-To get a production system setup:
+## To get a production system setup:
``` bash