Merge pull request #1 from fenix-hub/dev/dockerize

Dockerize project

Author: adrenallen

.dockerignore

@@ -0,0 +1,2 @@
+node_modules
+npm-debug.log

.env.example

@@ -1,2 +1,7 @@
-MONGO_URI=<mongo uri>
+MONGO_USERNAME=
+MONGO_PASSWORD=
+MONGO_HOST=mongo
+MONGO_PORT=27017
+MONGO_DB=ezlb
+MONGO_USE_SRV=false
 PORT=6999

Dockerfile

@@ -0,0 +1,10 @@
+FROM node:latest
+
+WORKDIR /usr/src/app
+COPY package*.json ./
+
+RUN npm install
+COPY . .
+
+EXPOSE 6999
+CMD [ "npm", "start" ]

README.md

@@ -117,6 +117,23 @@ To make the application reachable and always online, you will want to host it so
 - [Repl.it](https://replit.com/languages/nodejs)
     - Repl.it has an always-on tier of subscription. You can fork this repo and Replit can easily import it so you can edit it live. You may also be able to modify the app to use [Replit's key/value DB by using the code from this Replit that adds a layer of abstraction](https://github.com/adrenallen/replit-db-orm)
 
+## 🫙 Dockerized Setup 
+If you have [Docker](https://www.docker.com/) installed, you can simply run the `docker compose up -d` command to run the whole project in a containerized environment.  
+Even though this setup is best-suited for local development, it can be used in production too on your own server (VPS, AWS, Digital Ocean...).  
+
+You can also use `docker compose --profile=admin-panel up -d` to run a local admin panel for your mongo database.  
+
+Docker will use the same .env file used by the Node web server to resolve internal variables. In this way the containers are highly customizable together with the web server itself.  
+
+```
+# example configuration of .env in development
+MONGO_USERNAME=root
+MONGO_PASSWORD=example
+MONGO_HOST=mongo
+MONGO_PORT=27017
+MONGO_DB=mygame
+PORT=6999
+```
 
 ## :wrench: Customization
 

docker-compose.yml

@@ -0,0 +1,50 @@
+version: '3.1'
+
+volumes:
+  easyleaderboard-data:
+
+networks:
+  easyleaderboard-network:
+
+
+services:
+
+  server:
+    container_name: ezlb-server
+    build:
+      context: .
+      dockerfile: Dockerfile
+    restart: always
+    ports:
+      - ${PORT}:${PORT}
+    depends_on:
+      - mongo
+    networks:
+      - easyleaderboard-network
+
+  mongo:
+    container_name: ezlb-db
+    image: mongo
+    restart: always
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: example
+    volumes:
+      - easyleaderboard-data:/data/db
+    networks:
+      - easyleaderboard-network
+
+  mongo-express:
+    container_name: ezlb-mongo-panel
+    profiles:
+      - admin-panel
+    image: mongo-express
+    restart: always
+    ports:
+      - 127.0.0.1:8081:8081/tcp
+    environment:
+      ME_CONFIG_MONGODB_ADMINUSERNAME: ${MONGO_USERNAME}
+      ME_CONFIG_MONGODB_ADMINPASSWORD: ${MONGO_PASSWORD}
+      ME_CONFIG_MONGODB_URL: mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOST}:${MONGO_PORT}/
+    networks:
+      - easyleaderboard-network

mongoose_factory.js

@@ -1,6 +1,9 @@
 const mongoose = require('mongoose');
 
-mongoose.connect(process.env.MONGO_URI, {useNewUrlParser: true, useUnifiedTopology: true});
+mongoose.connect(
+    `mongodb${process.env.MONGO_USE_SRV ? '+srv' : ''}://${process.env.MONGO_USERNAME}:${process.env.MONGO_PASSWORD}@${process.env.MONGO_HOST}${process.env.MONGO_USE_SRV ? '' : ':'+process.env.MONGO_PORT}/${process.env.MONGO_DB}`, 
+    {useNewUrlParser: true, useUnifiedTopology: true}
+);
 
 mongoose.set('useFindAndModify', false);