From 83aa95079b5ab6702389272a247b782681ab0ed8 Mon Sep 17 00:00:00 2001 From: H4CK3R-01 Date: Thu, 2 Jun 2022 17:38:00 +0200 Subject: [PATCH] Updated deployment docs --- README.md | 30 ++++++++++++++++++++++++------ source/.env.example | 5 ++++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1c235e8..50d6e8d 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,29 @@ Umsetzung: Oberthema: "Data is the new oil" -# Setup for testing +# Deployment +## With docker +1. Das Dockerfile aus dem `source`-Ordner in das Root-Verzeichnis kopieren `cp source/Dockerfile .` +2. Das Docker Image erstellen `docker build . -t guesstheprice` +3. Die `source/.env.example`-Datei in das Root-Verzeichnis kopieren und zu `.env` umbenennen `cp source/.env.example .env` +4. Die `.env`-Datei so anpassen, das die Variablen die richtigen Werte haben +6. Den Container starten `docker run -d --name guesstheprice --env-file=.env guesstheprice` + +## Without docker +### Windows 1. Virtuelles Environment erstellen `python -m venv venv` 2. venv starten: `.\venv\Scripts\activate` -3. Requirements installieren `pip install -r requirements.txt` -4. Umgebungsvariablen setzen (see list below) - 1. Erstelle das `.env`-file anhand der `.env.example` und fülle sie mit den wichtigen variablen und token - 2. Alternativ variablen mit `export` oder `set` command setzen. (Windows `set`, Linux `export`) -5. Bot script starten `python source/bot.py` +3. Abhängigkeiten installieren `pip install -r requirements.txt` +4. Umgebungsvariablen setzen + 1. Erstelle die `.env`-Datei anhand der `.env.example` + 2. Alternativ die Variablen mit dem `set` Befehl setzen. +5. Bot Skripte starten `python source/bot.py & python source/daily_challenge.py` + +### Linux / MacOS +1. Virtuelles Environment erstellen `python -m venv venv` +2. venv starten: `source venv/bin/activate` +3. Abhängigkeiten installieren `pip install -r requirements.txt` +4. Umgebungsvariablen setzen + 1. Erstelle das `.env`-file anhand der `.env.example` + 2. Alternativ die Variablen mit dem `export` Befehl setzen. +5. Bot Skripte starten `python source/bot.py & python source/daily_challenge.py` diff --git a/source/.env.example b/source/.env.example index 3e32d24..56013a4 100644 --- a/source/.env.example +++ b/source/.env.example @@ -6,4 +6,7 @@ BOT_API_KEY= DATABASE_CONNECTION=mysql+pymysql://scott:tiger@localhost/foo?check_same_thread=False # SQLite -# DATABASE_CONNECTION=sqlite:///db.db?check_same_thread=False \ No newline at end of file +# DATABASE_CONNECTION=sqlite:///db.db?check_same_thread=False + +# Timezone +TZ=Europe/Berlin \ No newline at end of file