lee/Scraperr
1
0
Fork 0
mirror of https://github.com/jaypyles/Scraperr.git synced 2025-12-13 19:25:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: docs

Browse Source
This commit is contained in:
Jayden Pyles
2024-06-25 14:50:40 -05:00
parent e64e16244f
commit 1d20917cf7
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -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`