feat/deploy docker image (#249)

* feat: mongodb env file

* gitignore: add mongodb env

* update readme

* docker: update docker files

* feat: cd dockerhub

.env.example

@@ -10,14 +10,5 @@ STEAM_TOKEN=
 # TopGG Api Token (not required)
 TOPGG_TOKEN=
 
-# Mongo root username
-MONGO_INITDB_ROOT_USERNAME=app_user
-
-# Mongo root password
-MONGO_INITDB_ROOT_PASSWORD=app_password
-
-# Name of the init database
-MONGO_INITDB_DATABASE=faceitFinder
-
 # Database URI (change if needed)
 MONGO_URI=mongodb://app_user:app_password@faceitfinder_mongodb:27017/faceitFinder?authSource=admin

.env.mongodb.example

@@ -0,0 +1,8 @@
+# Mongo root username
+MONGO_INITDB_ROOT_USERNAME=app_user
+
+# Mongo root password
+MONGO_INITDB_ROOT_PASSWORD=app_password
+
+# Name of the init database
+MONGO_INITDB_DATABASE=faceitFinder

.github/workflows/dockerhub-publish.yml

@@ -0,0 +1,33 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches: ["release"]
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: justdams/faceitfinder-discordbot
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -72,6 +72,7 @@ typings/
 .env
 .env.local
 .env.test
+.env.mongodb
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

Dockerfile

@@ -2,6 +2,13 @@ FROM node:17.9.0
 
 ENV APP /usr/src/app
 
+ENV NODE_ENV=
+ENV TOKEN=
+ENV FACEIT_TOKEN=
+ENV STEAM_TOKEN=
+ENV TOPGG_TOKEN=
+ENV MONGO_URI=
+
 RUN mkdir -p $APP
 WORKDIR $APP
 

README.md

@@ -1,19 +1,16 @@
 # FaceitFinder
-## _Discord Bot which permit to find a faceit profile & its stats from a Steam id_
- [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/) [![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://docker.com/) [![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev/) 
+## _Discord Bot which permit to find a faceit profile & its stats from different parameters_
+ [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.com/) [![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://docker.com/)
 
 ## Features
 
-- Retrieve a Faceit account using a Steam ID, Steam UID, Steam profile link, in-game status or by mentioning  a Discord user who has linked to a Faceit account.
-- Get an elo graph.
-- Get statistics from the last game.
-- Link a Discord account whith a Faceit profile to get his statistics easily.
+- Retrieve a Faceit account using a **Steam ID**, **Steam UID**, **Steam profile link**, **in-game status**, **Faceit username** or by **mentioning a Discord user** who has linked to a Faceit account.
 
 ## Development
 
 Want to contribute? Great!
 
-### Installation
+### Run docker on a dev environment
 
 **Clone the repository:**
 
@@ -22,24 +19,55 @@ git clone git@github.com:JustDams/faceitFinder.git
 cd faceitFinder
 ```
 
-Rename the `.env.example` to `.env` and complete/update it with your information.
+**Setup env files:**
 
-**Run docker on a dev environment:**
+Copy the `.env.example` in `.env` and `.env.mongodb.example` in `.env.mongodb` then complete/update it with your information.
+
+```sh
+cp .env.example .env
+cp .env.mongodb.example .env.mongodb
+```
+
+**Run compose:**
 
 ```sh
 docker-compose -f docker-compose.dev.yml up
 ```
 
-**Run linter:**
+**To run the linter:**
 
 ```sh
 docker exec -it faceitfinder_dev npm run lint
 ```
 
-**Run docker on a prod environment:**
+### Run docker on a prod environment
+
+**Clone the repository:**
+
+```sh
+git clone git@github.com:JustDams/faceitFinder.git
+cd faceitFinder
+```
+
+**Got to the prod branch:**
+
+```sh
+git checkout prod
+```
+
+**Setup env files:**
+
+Copy the `.env.example` in `.env` and `.env.mongodb.example` in `.env.mongodb` then complete/update it with your information.
+
+```sh
+cp .env.example .env
+cp .env.mongodb.example .env.mongodb
+```
+
+**Run compose:**
 
 ```sh
-docker-compose -f docker-compose.prod.yml up
+docker-compose -f docker-compose.prod.yml up --build -d
 ```
 
 ## License

docker-compose.dev.yml

@@ -29,7 +29,7 @@ services:
     volumes:
       - ~/mongo-volume:/data/db
     env_file:
-      - .env
+      - .env.mongodb
     networks:
       - app
 

docker-compose.prod.yml

@@ -1,9 +1,7 @@
 version: '3'
 services:
   app:
-    build:
-      context: .
-      dockerfile: Dockerfile
+    image: justdams/faceitfinder-discordbot:latest
     restart: on-failure
     container_name: faceitfinder_prod
     command: npm start
@@ -29,7 +27,7 @@ services:
     volumes:
       - ~/mongo-volume:/data/db
     env_file:
-      - .env
+      - .env.mongodb
     networks:
       - app