From 44cd1308ba03a9909cc25dce48e4ce508fb0c948 Mon Sep 17 00:00:00 2001
From: b3yond <b3yond@riseup.net>
Date: Sun, 24 Jun 2018 00:24:01 +0200
Subject: [PATCH] added development instructions to README

---
 README.md            | 47 ++++++++++++++++++++++++++++++++++++++++++++
 static/css/style.css |  4 ++++
 2 files changed, 51 insertions(+)

diff --git a/README.md b/README.md
index 1524707..c715c50 100644
--- a/README.md
+++ b/README.md
@@ -152,3 +152,50 @@ less /var/log/syslog
 # for the nginx web server:
 less /var/log/nginx/example.org_error.log
 ```
+
+### Development Install
+
+If you want to install it locally to develop on it:
+
+```shell
+sudo apt install python3 virtualenv uwsgi uwsgi-plugin-python3 nginx git
+sudo git clone https://github.com/b3yond/ticketfrei
+cd ticketfrei
+```
+
+Install the necessary packages, create and activate virtualenv:
+
+```shell
+virtualenv -p python3 .
+. bin/activate
+```
+
+Install the dependencies:
+
+```shell
+pip install tweepy pytoml Mastodon.py bottle pyjwt pylibscrypt Markdown
+```
+
+Configure the bot:
+
+```shell
+cp config.toml.example config.toml
+vim config.toml
+```
+
+This configuration is only for the admin. Users can log into
+twitter/mastodon/mail and configure their personal bot on the settings page.
+
+```shell
+# create folder for socket & database
+sudo mkdir /var/ticketfrei
+sudo chown $USER:$USER -R /var/ticketfrei
+
+# create folder for logs
+sudo mkdir /var/log/ticketfrei
+sudo chown $USER:$USER -R /var/log/ticketfrei
+
+# start Ticketfrei
+./frontend.py & ./backend.py &
+```
+
diff --git a/static/css/style.css b/static/css/style.css
index 54590a4..3dc8126 100644
--- a/static/css/style.css
+++ b/static/css/style.css
@@ -41,3 +41,7 @@ input[type=text], input[type=password] {
     display: inline-block;
     border: 1px solid #ccc;
 }
+
+h2 {
+    padding-top: 1em;
+}