From 848c19f344b40021f073c217fcb522187d81548f Mon Sep 17 00:00:00 2001 From: JChris246 Date: Thu, 13 Mar 2025 23:48:23 -0400 Subject: [PATCH] chore: add to README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 733c855..c9fbace 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,12 @@ cd seek-tune/client npm install ``` +## Docker 🐋 + +Should you choose to run as a docker container, the docker compose in the root of the project can be used run start the service with the command docker-compose up -d. With the first run, the image will be built using the Dockerfile also found in the root of the project. If you need to rebuild the image after the first run of docker compose, the image can be built with the docker build . command from the root of the project. + +*Note: Only the features available in the app UI are available while running the docker container.* + ## Usage :bicyclist: #### ▸ Start the Client App 🏃‍♀️‍➡️