113 lines
1.6 KiB
Markdown
113 lines
1.6 KiB
Markdown
|
|
|
|
# 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
|
|
```
|
|
#### Remove the dangling image created
|
|
|
|
An node image was created as a requirement for the build process, to ensure dependencies are installed. This image is temporary and should be remove afer the built project is moved to nginx runtime image.
|
|
|
|
```
|
|
docker rmi $(docker images -f "dangling=true" -q)
|
|
```
|
|
|
|
### Podman
|
|
|
|
#### Run Podman Compose
|
|
|
|
```
|
|
podman-compose up -d
|
|
```
|
|
|
|
#### Remove the dangling image created
|
|
|
|
```
|
|
podman rmi $(docker images -f "dangling=true" -q)
|
|
```
|
|
|
|
### 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>
|
|
```
|