From c1a40ea5caa68d18a4e290ca3573f8d353acb7c1 Mon Sep 17 00:00:00 2001
From: Ernesto Rico Schmidt <ernesto@helsinki.at>
Date: Sun, 4 Oct 2020 22:12:30 -0400
Subject: [PATCH] Update README
Close #49
---
README.rst | 49 ++++++++++++++++++-------------------------------
1 file changed, 18 insertions(+), 31 deletions(-)
diff --git a/README.rst b/README.rst
index fcbe942f..8d14dcf6 100644
--- a/README.rst
+++ b/README.rst
@@ -12,57 +12,52 @@ If you have a working Docker environment, do::
and log into it at http://127.0.0.1:8000/admin/ with username "admin" and password "admin". Full setup without Docker is done as described below.
-
To get setup you must have the following installed:
- * PostgresSQL or MySQL-Client Development libraries
- * JPEG library development files
- * Python 3.5 including Development files
- * virtualenv 1.11
-
-In Debian or Ubuntu (or derivatives) you should be able to achieve this with this command::
+* PostgresSQL or MySQL client development libraries
+* JPEG library development files
+* Python 3 including development files
-Using PostgreSQL:
+In Debian or Ubuntu (or derivatives) you should be able to achieve this with this command:
- $ sudo apt-get install postgresql postgresql-contrib libjpeg-dev python3.6 virtualenv
+* Using PostgreSQL::
+ $ sudo apt-get install postgresql postgresql-contrib libjpeg-dev python3 python3-dev
-Using MySQL:
-
- $ sudo apt-get install default-libmysqlclient-dev libjpeg-dev python3.6 virtualenv
+* Using MySQL::
+ $ sudo apt-get install libmysqlclient-dev libjpeg-dev python3 python3-dev
Setting up the environment
--------------------------
Create a virtual environment where the dependencies will live::
- $ virtualenv -p python3.6 python
+ $ python3 -m venv python
$ source python/bin/activate
(python)$
Change into the base directory of this software and install the project dependencies::
- (python)$ pip3 install -r requirements.txt
+ (python)$ pip install -r requirements.txt
Setting up the configuration
------------------------
+----------------------------
By default the project is set up to run on a SQLite database.
-Create a file pv/local_settings.py and add at least the following line::
+Create a file ``pv/local_settings.py`` and add at least the following line::
SECRET_KEY = 'secret key'
(obviously replacing "secret key" with a key of your choice).
-
Setting up PostgreSQL
-----------------
+---------------------
We recommend using PostgreSQL in order to be able to use the collation utf8mb64_unicode_ci and thus being able to display all languages.
-To use PostgreSQL, add the following to your local_settings.py (before migrating) and add your credentials::
+To use PostgreSQL, add the following to your ``local_settings.py`` (before migrating) and add your credentials::
DATABASES = {
'default': {
@@ -75,13 +70,12 @@ To use PostgreSQL, add the following to your local_settings.py (before migrating
}
}
-
Setting up MySQL
----------------
**Note:** When adding your database, make sure you **don't** use the collation utf8mb4_unicode_ci or you will get a key length error during migration. (use e.g. utf8_general_ci instead).
-To use MySQL, add the following to your local_settings.py (before migrating)::
+To use MySQL, add the following to your ``local_settings.py`` (before migrating)::
DATABASES = {
'default': {
@@ -92,7 +86,7 @@ To use MySQL, add the following to your local_settings.py (before migrating)::
}
}
-Create a file pv/mysql.cnf and give your MySQL credentials::
+Create a file ``pv/mysql.cnf`` and give your MySQL credentials::
[client]
database =
@@ -102,20 +96,14 @@ Create a file pv/mysql.cnf and give your MySQL credentials::
password =
default-character-set = utf8
-
Setting up the database
-----------------
+-----------------------
Then run::
(python)$ python manage.py migrate
(python)$ python manage.py loaddata program/fixtures/*.yaml
-Open pv/local_settings.py again and add the line::
-
- USE_TZ = False
-
-
Adding an admin user
--------------------
@@ -123,7 +111,6 @@ In order to create an admin user (which you will need to login to the webinterfa
(python)$ python manage.py createsuperuser
-
Running a web server
--------------------
@@ -134,4 +121,4 @@ In development you should run::
After this you can open http://127.0.0.1:8000/admin in your browser and log in with username "admin" and password "admin".
-Make sure to change your password by visiting http://127.0.0.1:8000/admin/auth/user/1/password/
\ No newline at end of file
+Make sure to change your password by visiting http://127.0.0.1:8000/admin/auth/user/1/password/
--
GitLab