Added Docker Compose for self hosting Akinator (#12)

* Added Docker Compose for self hosting MongoDB and Dockerfile changes

* Added self host section in README

Author: advnpzn

.dockerignore

@@ -18,4 +18,11 @@ coverage.xml
 .mypy_cache
 .pytest_cache
 .hypothesis
-venv
+venv
+compose.yml
+Dockerfile
+Procfile
+app.json
+.git
+.gitignore
+data

Dockerfile

@@ -3,11 +3,9 @@ FROM python:3.9-slim
 
 WORKDIR /app
 
-COPY requirements.txt requirements.txt
+COPY . .
 
-RUN pip install -r requirements.txt
-
-COPY  . .
+RUN pip install --no-cache-dir -r requirements.txt
 
 CMD [ "python", "__main__.py"]
 

README.md

@@ -3,13 +3,34 @@ A Telegram bot where you can play the Akinator Guessing game
 check out [Akinator](https://t.me/aki_akinator_bot) on Telegram.
 If the bot is offline, contact me on telegram, so that I can look into it.
 
-# Deployments
+# Self Host (Containers)
+Create a `.env` file and fill up the following in it.
+```
+BOT_TOKEN=<your-bot-token>
+
+# Mongo DB Username and Password
+MONGO_ROOT_USER=admin
+MONGO_ROOT_PASSWORD=admin
+
+# Mongo Express Username and Password
+MONGOEXPRESS_LOGIN=admin
+MONGOEXPRESS_PASSWORD=admin
+```
+Change the username & password for MongoDB and MongoExpress as you like above.
+
+Put the `compose.yml` in the same directory where `.env` file is present.
+After that, run the following:
+```
+docker compose up -d
+```
+# Cloud Deployments (I'm not sure if this still works)
+
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?button-url=https%3A%2F%2Fgithub.com%2Fadenosinetp10%2FAkinator-bot&template=https%3A%2F%2Fgithub.com%2Fadenosinetp10%2FAkinator-bot
 )
 
 [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2Fadenosinetp10%2FAkinator-Bot&envs=aki_mongo_host%2Cbot_token&aki_mongo_hostDesc=mongoDB+URI+for+accessing+database.&bot_tokenDesc=Telegram+Bot+token+obtained+from+BotFather&referralCode=9C9po6)
 
-## Setting up the database
+## Setting up the database (In MondoDB Atlas if you don't wanna self host the Database)
 
 Akinator uses **MongoDB** by default to store the user stats such as number of games won, abandoned, played and their telegram provided info and also to facilitate for the leaderboard function. MongoDB is easy to set up and work with, noSQL is easy compared to SQL. MongoDB even offers free cloud database for small use. You can create a local mongoDB cluster or use the online mongoDB Atlas to start.. Here, the scope of the following steps is to follow on the footpath of the online setup using mongoDB Atlas.
 

compose.yml

@@ -0,0 +1,39 @@
+services:
+
+  # MongoDB
+  mongo:
+    container_name: mongo-db
+    image: mongo
+    restart: unless-stopped
+    volumes:
+      - ./data:/data/db
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: ${MONGO_ROOT_USER}
+      MONGO_INITDB_ROOT_PASSWORD: ${MONGO_ROOT_PASSWORD}
+
+  # This is the UI dashboard for MongoDB if you want to manage the DB graphically through a browser UI.
+  mongo-express:
+    container_name: "mongo-express"
+    image: mongo-express
+    restart: unless-stopped
+    ports:
+      - "8081:8081"
+    environment:
+      ME_CONFIG_MONGODB_SERVER: mongo
+      ME_CONFIG_MONGODB_PORT: 27017
+      ME_CONFIG_MONGODB_ENABLE_ADMIN: false
+      ME_CONFIG_MONGODB_AUTH_DATABASE: admin
+      ME_CONFIG_MONGODB_ADMINUSERNAME: ${MONGO_ROOT_USER}
+      ME_CONFIG_MONGODB_ADMINPASSWORD: ${MONGO_ROOT_PASSWORD}
+      ME_CONFIG_BASICAUTH_USERNAME: ${MONGOEXPRESS_LOGIN}
+      ME_CONFIG_BASICAUTH_PASSWORD: ${MONGOEXPRESS_PASSWORD}
+
+  # Akinator Telegram Bot
+  akinator-bot:
+    container_name: akinator-tg-bot
+    image: advnpzn/akinator:latest
+    restart: unless-stopped
+    environment:
+      bot_token: ${BOT_TOKEN}
+      aki_mongo_host: "mongodb://${MONGO_ROOT_USER}:${MONGO_ROOT_PASSWORD}@mongo:27017"
+      

database.py

@@ -1,9 +1,12 @@
 from typing import Any
-from pymongo import MongoClient
+from pymongo import MongoClient, database
 from config import AKI_MONGO_HOST
 
-my_client = MongoClient(host=AKI_MONGO_HOST)
-my_db = my_client["aki-db"]
+try:
+    my_client = MongoClient(host=AKI_MONGO_HOST)
+    my_db = my_client["aki-db"]
+except Exception as e:
+    print("Error: ", e)
 
 
 def addUser(user_id: int, first_name: str, last_name: str, user_name: str) -> None: