fwt/README.md

100 lines
1.3 KiB
Markdown

![FWT Logo](fwt/images/logo.avif)
# Fast WebApp Template
## How to Use
#### Clone the Repo
```
git clone --depth 1 https://git.patalcala.com/patalcala9/fwt.git <project-name>
```
#### Navigate to the project
```
cd <project-name>
```
#### Refresh GIT
```
sudo rm -rf .git
git init
```
#### Install Depedencies
```
pnpm install
```
#### Make sure to update the dependencies first
```
pnpm update
```
## To Use Background
Place your background image in `assets/images/background.avif` or `assets/images/background.webp`.
Then, enable by adding `<Background image />` or `<Background color="#123456">`
## How to Run
```
pnpm dev
```
## How to Deploy
### Standard
```
pnpm build
```
### Docker
#### Edit name and port on docker-compose.yml
```
sudo vim docker-compose.yml
```
#### Run Docker Compose
```
docker compose up -d
```
### Podman
#### Run Podman Compose
```
podman-compose up -d
```
### Podman Quadlet
#### Edit Quadlet Container
```
sudo vim quadlet/quadlet.container
```
#### Copy and Rename the Quadlet to proper directory
```
mkdir -p ~/.config/containers/systemd/
sudo cp quadlet/quadlet.container ~/.config/containers/systemd/<name>.container
```
#### Start at Systemd
```
systemctl --user daemon-reload
systemctl --user start <name>
```