From a07271b5919015774bb1b7a9fb0a817e586260ce Mon Sep 17 00:00:00 2001 From: Aurthur Musendame Date: Thu, 13 Feb 2025 21:37:15 +0200 Subject: [PATCH] added dev docker setup --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 898a554f..b96d941a 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,18 @@ Felicity is the quality of being good, pleasant, or desirable. --- -## **Installation** +## **Development setup (docker)** + +```bash +git clone https://github.com/beak-insights/felicity-lims.git +cd felicity-lims +# build and run +docker compose -f docker-compose.dev.yml up -d --build +# database setup +docker compose -f docker-compose.dev.yml exec felicity-api felicity-lims db upgrade +``` + +## **Production Installation** ### **Using Docker** *(Recommended)* Felicity LIMS can be quickly deployed using Docker Compose. @@ -61,6 +72,7 @@ Felicity LIMS can be quickly deployed using Docker Compose. ```bash git clone https://github.com/beak-insights/felicity-lims.git cd felicity-lims +docker compose -f docker-compose.dev.yml up -d --build ``` #### **Step 2**: Choose a Preset @@ -77,9 +89,9 @@ Choose between FastAPI serving static files or using Nginx/Caddy as a reverse pr #### **Step 3**: Deploy ```bash -docker-compose -f docker-compose.prod.yml up -d --build -docker-compose -f docker-compose.prod.yml exec bash -c "felicity-lims upgrade" -docker-compose -f docker-compose.prod.yml logs -f -n100 +docker compose -f docker-compose.yml up -d --build +docker compose -f docker-compose.yml exec bash -c "felicity-lims upgrade" +docker compose -f docker-compose.yml logs -f -n100 ``` ### **Manual Installation** *(Alternative)*