From 1d20917cf764dd15cea6a1432ddfaf332213e9ab Mon Sep 17 00:00:00 2001 From: Jayden Pyles Date: Tue, 25 Jun 2024 14:50:40 -0500 Subject: [PATCH] chore: docs --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e9faca6..9fba5b6 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,23 @@ Template designed to quickly build full stack apps. - Containerization: Docker/Docker Compose -- Frontend: React.ts +- Frontend: React/Next.js - Backend: FastAPI -- Frameworks/Libraries: PDM, tailwindcss +- Frameworks/Libraries: PDM, TailwindCSS ## Deployment Uses `make` to quickly dispatch `docker-compose` commands. -- `build`: builds the container using `docker-compose build ` - -- `up`: ups the container using `docker-compose up` - - `deps`: rebuilds the frontend to deploy statically using the api -Ex: `make deps build up` +- `build`: builds the container using `docker-compose build ` + +- `up-dev`: ups the container using `docker-compose -f docker-compose.yml up` + +- `up-prd`: ups the container using `docker-compose -f docker-compose.yml -f docker-compose.dev.yml up` + which will deploy with local volumes. + +Ex: `make deps build up-dev`