docs: readme

This commit is contained in:
Jayden Pyles
2024-05-18 22:25:05 -05:00
parent 875bce55c4
commit f2bfc309f4
2 changed files with 23 additions and 3 deletions
+22
View File
@@ -1 +1,23 @@
# Webapp Template
Template designed to quickly build full stack apps.
## Technologies
- Containerization: Docker/Docker Compose
- Frontend: React
- Backend: FastAPI
## 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`
+1 -3
View File
@@ -1,7 +1,5 @@
version: "3"
services:
frontend:
# command: ["npm", "run", "start"]
volumes:
- .:/project/app/
- ./api:/project/api
- "$PWD/build:/project/api/build"