refactor(automation): Simplify docker compose files

docker/.env.example

@@ -13,12 +13,15 @@ HOST_NAME=http://localhost
 NODE_ENV=local
 MONGO_MAX_POOL_SIZE=500
 MONGO_MIN_POOL_SIZE=100
+DOCKER_MONGO_PORT=27017
 # MONGO USER
 MONGO_INITDB_ROOT_USERNAME=root
 # MONGO PASSWORD
 MONGO_INITDB_ROOT_PASSWORD=secret
 MONGO_URL=mongodb://root:secret@mongodb:27017/novu-db?authSource=admin
 REDIS_HOST=redis
+
+DOCKER_REDIS_SERVICE_PORT=6379
 REDIS_PASSWORD=
 REDIS_CACHE_SERVICE_HOST=
 
@@ -60,3 +63,5 @@ SENTRY_DSN=
 # change these values
 NEW_RELIC_APP_NAME=
 NEW_RELIC_LICENSE_KEY=
+
+DOCKER_LOCALSTACK_PORT=4566

docker/Readme.md

@@ -31,6 +31,26 @@ docker-compose -f ./local/deployment/docker-compose.yml up
 
 Now visit [http://127.0.0.1:4200](http://127.0.0.1:4200) to start using Novu.
 
+### Developing
+
+Clone the Novu repo and enter the docker directory locally:
+
+```sh
+# Get the code
+git clone https://github.com/novuhq/novu
+
+# Go to the docker folder
+cd novu/docker
+
+# Copy the example env file
+cp .env.example ./local/development/.env
+
+# Start Novu
+docker-compose -f ./local/development/docker-compose.yml up
+```
+
+Now visit [http://127.0.0.1:4200](http://127.0.0.1:4200) to start using Novu.
+
 ### Securing your setup
 
 While we provide you with some example secrets for getting started, you should NEVER deploy your Novu setup using the defaults provided.

docker/local/development/docker-compose.yml

@@ -8,7 +8,7 @@ services:
     environment:
       - SERVICES=s3
     ports:
-      - "4566:4566"
+      - "${DOCKER_LOCALSTACK_PORT}:4566"
     volumes:
       - "${TMPDIR:-/tmp/localstack}:/tmp/localstack"
       - "/var/run/docker.sock:/var/run/docker.sock"
@@ -21,7 +21,7 @@ services:
     image: mongo
     network_mode: bridge
     ports:
-      - "27017:27017"
+      - "${DOCKER_MONGO_PORT}:27017"
     volumes:
       - "${TMPDIR:-/tmp/mongo}:/db/data"
     healthcheck:
@@ -33,7 +33,7 @@ services:
     image: redis
     network_mode: bridge
     ports:
-      - "6379:6379"
+      - "${DOCKER_REDIS_SERVICE_PORT}:6379"
     healthcheck:
       test: "bash -c 'redis-cli ping'"
       retries: 5