Merge pull request #28 from MichaelZhao21/mongo-atlas

Added default support for MongoDB Atlas

Author: MichaelZhao21

.env.template

@@ -1,5 +1,6 @@
 JURY_NAME=
 JURY_ADMIN_PASSWORD=
 
+MONGODB_URI=
 MONGODB_USER=
 MONGODB_PASS=

README.md

@@ -4,9 +4,28 @@ A project designed to create a new pairwise judging system using modern technolo
 
 # Deployment
 
+## Setup
+
+Copy `.env.template` into `.env` and fill in the environmental variables
+
+Environmental Variables:
+
+```
+JURY_NAME="Name of the jury app [Displays on the app!]"
+JURY_ADMIN_PASSWORD="Password used to log into the admin dashboard"
+
+MONGODB_URI="MongoDB connection URI string [ONLY for MongoDB Atlas]"
+MONGODB_USER="Username for local mongo container [ONLY use if running local mongo instance]"
+MONGODB_PASS="Password for local mongo container [ONLY use if running local mongo instance]"
+```
+
+I suggest you run the app with MongoDB Atlas! Create a free account and database [here](https://www.mongodb.com/atlas/database). It should provide you a URI string to fill into the `.env` file.
+
+If you would rather use a local instance deployed with docker-compose, you can simply fill in the username and password you want to use with that database.
+
 ## With Docker
 
-Run `docker compose up`
+Run `docker compose up` after configuring the `.env` file. If you want to run mongo locally, run `docker compose -f docker-compose-mongo.yml`.
 
 # Developing
 
@@ -16,9 +35,11 @@ Requirements:
 
 * [Docker](https://www.docker.com/)
 
-Copy `.env.template` into `.env` and fill in the environmental variables
+Copy `.env.template` into `.env` and fill in the environmental variables (see above).
+
+Simply run `docker compose -f docker-compose.dev.yml up` and open the page at `localhost:3000`.
 
-Simply run `docker compose -f docker-compose.dev.yml up` and open the page at `localhost:3000`
+If you want to run mongo locally, run `docker compose -f docker-compose-mongo.dev.yml`.
 
 ## Manual Installation
 

docker-compose-mongo.dev.yml

@@ -0,0 +1,78 @@
+version: '3.9'
+services:
+    mongo:
+        build:
+            context: './'
+            dockerfile: mongo.Dockerfile
+        restart: always
+        environment:
+            - MONGO_INITDB_ROOT_USERNAME=${MONGODB_USER}
+            - MONGO_INITDB_ROOT_PASSWORD=${MONGODB_PASS}
+            - MONGO_INITDB_DATABASE=jury
+            - MONGO_REPLICA_SET_NAME=rs0
+        ports:
+            - 127.0.0.1:27107:27017
+        volumes:
+            - './data:/data/db'
+            - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js
+            - ./init-mongo-dummy.js:/docker-entrypoint-initdb.d/init-mongo-dummy.js
+        networks:
+            - jury-dev-network
+
+    mongorssetup:
+        depends_on:
+            - 'mongo'
+        image: mongo:latest
+        environment:
+            - MONGODB_USER=${MONGODB_USER}
+            - MONGODB_PASS=${MONGODB_PASS}
+        volumes:
+            - .:/scripts
+        restart: "no"
+        entrypoint: [ 'bash', '/scripts/init-mongo-rs.sh' ]
+        networks:
+            - jury-dev-network
+
+    rust-dev:
+        depends_on:
+            - 'mongo'
+            - 'mongorssetup'
+        container_name: jury-dev-backend
+        environment:
+            - MONGODB_URI=mongodb://${MONGODB_USER}:${MONGODB_PASS}@mongo:27017/
+            - JURY_ADMIN_PASSWORD=${JURY_ADMIN_PASSWORD}
+            - PORT=8000
+            - CARGO_TARGET_DIR=/root/target
+        build:
+            context: './'
+            dockerfile: dev.Dockerfile
+        ports:
+            - 8000:8000
+        volumes:
+            - .:/jury
+            - ./.cargo/registry:/usr/local/cargo/registry
+            - ./.target:/root/target
+        networks:
+            - jury-dev-network
+
+    node-dev:
+        depends_on:
+            - 'rust-dev'
+        container_name: jury-dev-frontend
+        environment:
+            - REACT_APP_JURY_NAME=${JURY_NAME}
+            - REACT_APP_JURY_URL=http://localhost:8000/api
+            - REACT_APP_HUB=${HEHE:-}
+        build:
+            context: './'
+            dockerfile: client/dev.Dockerfile
+        ports:
+            - 3000:3000
+        volumes:
+            - ./client:/client
+        networks:
+            - jury-dev-network
+
+networks:
+    jury-dev-network:
+        driver: bridge

docker-compose-mongo.yml

@@ -0,0 +1,58 @@
+version: "3.9"
+services:
+    mongo:
+        build:
+            context: './'
+            dockerfile: mongo.Dockerfile
+        restart: always
+        environment:
+            - MONGO_INITDB_ROOT_USERNAME=${MONGODB_USER}
+            - MONGO_INITDB_ROOT_PASSWORD=${MONGODB_PASS}
+            - MONGO_INITDB_DATABASE=jury
+            - MONGO_REPLICA_SET_NAME=rs0
+        ports:
+            - 127.0.0.1:27107:27017
+        volumes:
+            - './data:/data/db'
+            - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js
+        networks:
+            - jury-network
+
+    mongorssetup:
+        depends_on:
+            - 'mongo'
+        image: mongo:latest
+        environment:
+            - MONGODB_USER=${MONGODB_USER}
+            - MONGODB_PASS=${MONGODB_PASS}
+        volumes:
+            - .:/scripts
+        restart: "no"
+        entrypoint: [ 'bash', '/scripts/init-mongo-rs.sh' ]
+        networks:
+            - jury-dev-network
+
+    rust:
+        depends_on:
+            - 'mongo'
+            - 'mongorssetup'
+        container_name: jury-main
+        environment:
+            - MONGODB_URI=mongodb://${MONGODB_USER}:${MONGODB_PASS}@mongo:27017/
+            - JURY_ADMIN_PASSWORD=${JURY_ADMIN_PASSWORD}
+            - PORT=8000
+        build:
+            context: './'
+            dockerfile: Dockerfile
+            args:
+                - REACT_APP_JURY_NAME=${JURY_NAME}
+                - REACT_APP_JURY_URL=/api
+                - REACT_APP_HUB=${HEHE:-}
+        ports:
+            - 8000:8000
+        networks:
+            - jury-network
+
+networks:
+    jury-network:
+        driver: bridge

docker-compose.dev.yml

@@ -1,45 +1,9 @@
 version: '3.9'
 services:
-    mongo:
-        build:
-            context: './'
-            dockerfile: mongo.Dockerfile
-        restart: always
-        environment:
-            - MONGO_INITDB_ROOT_USERNAME=${MONGODB_USER}
-            - MONGO_INITDB_ROOT_PASSWORD=${MONGODB_PASS}
-            - MONGO_INITDB_DATABASE=jury
-            - MONGO_REPLICA_SET_NAME=rs0
-        ports:
-            - 127.0.0.1:27107:27017
-        volumes:
-            - './data:/data/db'
-            - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js
-            - ./init-mongo-dummy.js:/docker-entrypoint-initdb.d/init-mongo-dummy.js
-        networks:
-            - jury-dev-network
-
-    mongorssetup:
-        depends_on:
-            - 'mongo'
-        image: mongo:latest
-        environment:
-            - MONGODB_USER=${MONGODB_USER}
-            - MONGODB_PASS=${MONGODB_PASS}
-        volumes:
-            - .:/scripts
-        restart: "no"
-        entrypoint: [ 'bash', '/scripts/init-mongo-rs.sh' ]
-        networks:
-            - jury-dev-network
-
     rust-dev:
-        depends_on:
-            - 'mongo'
-            - 'mongorssetup'
         container_name: jury-dev-backend
         environment:
-            - MONGODB_URI=mongodb://${MONGODB_USER}:${MONGODB_PASS}@mongo:27017/
+            - MONGODB_URI=${MONGODB_URI}
             - JURY_ADMIN_PASSWORD=${JURY_ADMIN_PASSWORD}
             - PORT=8000
             - CARGO_TARGET_DIR=/root/target
@@ -52,8 +16,6 @@ services:
             - .:/jury
             - ./.cargo/registry:/usr/local/cargo/registry
             - ./.target:/root/target
-        networks:
-            - jury-dev-network
 
     node-dev:
         depends_on:
@@ -70,9 +32,3 @@ services:
             - 3000:3000
         volumes:
             - ./client:/client
-        networks:
-            - jury-dev-network
-
-networks:
-    jury-dev-network:
-        driver: bridge

docker-compose.yml

@@ -1,44 +1,9 @@
 version: "3.9"
 services:
-    mongo:
-        build:
-            context: './'
-            dockerfile: mongo.Dockerfile
-        restart: always
-        environment:
-            - MONGO_INITDB_ROOT_USERNAME=${MONGODB_USER}
-            - MONGO_INITDB_ROOT_PASSWORD=${MONGODB_PASS}
-            - MONGO_INITDB_DATABASE=jury
-            - MONGO_REPLICA_SET_NAME=rs0
-        ports:
-            - 127.0.0.1:27107:27017
-        volumes:
-            - './data:/data/db'
-            - ./init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js
-        networks:
-            - jury-network
-
-    mongorssetup:
-        depends_on:
-            - 'mongo'
-        image: mongo:latest
-        environment:
-            - MONGODB_USER=${MONGODB_USER}
-            - MONGODB_PASS=${MONGODB_PASS}
-        volumes:
-            - .:/scripts
-        restart: "no"
-        entrypoint: [ 'bash', '/scripts/init-mongo-rs.sh' ]
-        networks:
-            - jury-dev-network
-
     rust:
-        depends_on:
-            - 'mongo'
-            - 'mongorssetup'
         container_name: jury-main
         environment:
-            - MONGODB_URI=mongodb://${MONGODB_USER}:${MONGODB_PASS}@mongo:27017/
+            - MONGODB_URI=${MONGODB_URI}
             - JURY_ADMIN_PASSWORD=${JURY_ADMIN_PASSWORD}
             - PORT=8000
         build:
@@ -50,9 +15,3 @@ services:
                 - REACT_APP_HUB=${HEHE:-}
         ports:
             - 8000:8000
-        networks:
-            - jury-network
-
-networks:
-    jury-network:
-        driver: bridge