From 3f9ff8f53efe6820ae2dc0b7bd282bc883f72df3 Mon Sep 17 00:00:00 2001 From: Marko Ilijoski Date: Sun, 16 Mar 2025 21:28:03 +0100 Subject: [PATCH] update readme with 'Dockerized env' section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index cf34772..cbed41f 100644 --- a/README.md +++ b/README.md @@ -158,6 +158,25 @@ curl -X GET "https://api.textbee.dev/api/v1/gateway/devices/YOUR_DEVICE_ID/get-r ``` 4. Ensure your domain points to your VPS and Caddy is configured properly. +### Dockerized env +#### Requirements: +- Docker installed +- docker-compose installed +1. After setting up Firebase, update your `.env` in `web` && `api` folder. + ```bash + cd web && cp .env.example .env \ + && cd ../api && cp .env.example .env + ``` +2. Navigate to root folder and execute docker-compose.yml file. + This will spin up `web` container, `api` container alongside with `MongoDB` and `MongoExpress`. `TextBee` database will be automatically created. + ```bash + docker-compose up -d + ``` + To stop the containers simply type + ```bash + docker-compose down + ``` + ## Contributing Contributions are welcome!