Efren Yevale Varela
5d99a14a39
Simplified graceful shutdown
|
1 mês atrás | |
|---|---|---|
| .vscode | 1 mês atrás | |
| messages | 1 mês atrás | |
| project.inlang | 1 mês atrás | |
| src | 1 mês atrás | |
| static | 1 mês atrás | |
| .dockerignore | 1 mês atrás | |
| .gitignore | 1 mês atrás | |
| .npmrc | 1 mês atrás | |
| AGENTS.md | 1 mês atrás | |
| Dockerfile | 1 mês atrás | |
| LICENSE.md | 1 mês atrás | |
| README.md | 1 mês atrás | |
| config.json.example | 1 mês atrás | |
| jsconfig.json | 1 mês atrás | |
| package.json | 1 mês atrás | |
| pnpm-lock.yaml | 1 mês atrás | |
| pnpm-workspace.yaml | 1 mês atrás | |
| vite.config.js | 1 mês atrás |
README.md
testing-proxy
A modern SvelteKit application with Svelte 5 runes, Tailwind CSS, and Flowbite components.
Setup
Install dependencies:
pnpm install
Configuration
Copy the example configuration to create your local config.json:
cp config.json.example config.json
This file contains settings for database and server configuration. See Configuration below for available options.
Development
Start the dev server on http://localhost:3000:
npm run dev
# Auto-open in browser
npm run dev -- --open
Hot module reload enabled by default.
Build & Deploy
Create a production build:
npm run build
Preview the production build locally:
npm run preview
Production output goes to /build/ (configured for Node.js via @sveltejs/adapter-node).
Docker
The application includes a multi-stage Dockerfile for production deployments using Node.js 24 Alpine.
Docker Run
Build the Docker image:
docker build -t testing-proxy .
Run the container with a mounted configuration file:
docker run -d \
--name testing-proxy \
-p 3000:3000 \
--volume ./config.json:/opt/app/server/config.json:ro \
--volume ./data:/opt/app/data \
testing-proxy
The flags:
--volume ./config.json:/opt/app/server/config.json:ro— Mounts your localconfig.jsonas read-only inside the container--volume ./data:/opt/app/data— Persists the SQLite database across container restarts
Ensure config.json exists before running:
cp config.json.example config.json
mkdir -p data
Docker Compose
Use Docker Compose for orchestrated deployments with secrets management:
version: '3.8'
services:
app:
image: testing-proxy:latest
container_name: testing-proxy
ports:
- "3000:3000"
secrets:
- source: config_secret
target: /opt/app/server/config.json
uid: "1000"
gid: "1000"
mode: 0400
volumes:
- ./data:/opt/app/data # Persist SQLite database
restart: unless-stopped
secrets:
config_secret:
file: ./config.json
Save as docker-compose.yml and run:
docker-compose up -d
The secrets section:
source— Named secret reference (config_secret)target— Container path where the config is mounted (/opt/app/server/config.json)uid/gid— User/group IDs inside the container (1000 for app user)mode— File permissions (0400= read-only for owner)
Configuration
Before running Docker containers, create your configuration file:
cp config.json.example config.json
Both docker run and docker-compose methods expect config.json to exist on your host machine and mount it into the container.
Data Persistence
For Docker Compose deployments, the ./data volume persists the SQLite database across container restarts. Ensure the data/ directory is writable:
mkdir -p data
chmod 755 data
Project Structure
src/routes/— SvelteKit filesystem routessrc/lib/— Reusable components and utilities (access via$libalias)src/app.html— HTML shell (dark mode enabled viaclass="dark")
Tech Stack
- Framework: SvelteKit 2.63.0 with Svelte 5 (runes mode)
- Styling: Tailwind CSS 4.3.0 via
@tailwindcss/vite+ Forms/Typography plugins - Components: Flowbite Svelte 1.33.1 + Flowbite Icons
- Build Tool: Vite 8.0.16
- Adapter: Node.js (
@sveltejs/adapter-node)
Important Notes
Svelte 5 Runes (Mandatory)
All .svelte files use runes mode by default. Use:
$state()for reactive variables$derivedfor computed values$effect()for side effects{#snippet}for component snippets (e.g., icon slots)
See Svelte 5 runes documentation.
Styling
- Dark mode hardcoded in
app.html(removeclass="dark"from<html>to disable) - Use Tailwind utilities directly; no CSS Modules
- Scoped styles available via
<style>blocks in.sveltefiles
Internationalization (i18n)
The project uses Paraglide JS for i18n with:
- Languages: English (en-US) and Spanish (es-MX)
- Auto-localized Routes: URLs automatically prefixed with language code (e.g.,
/en/or/es/) - Runtime API: Use
getLocale(),setLocale(), anddeLocalizeUrl()from$lib/paraglide/runtime.js - Messages: Locale-aware functions in
$lib/paraglide/messages.js
All routes are automatically localized. No manual language handling needed.
Configuration Reference
The config.json file (copied from config.json.example) controls server and database settings:
Database Configuration
{
"database": {
"type": "sqlite3",
"sqlite3": {
"fileMustExist": false,
"filename": "app.db",
"readonly": false,
"timeout": 5000,
"performance": {
"foreignKeys": true,
"journalMode": "wal",
"synchronous": 1,
"tempStore": "memory"
}
}
},
"password": {
"algorithm": "argon2id",
"options": {
"memoryCost": 61440,
"timeCost": 3,
"parallelism": 1
}
}
}
database.type— Database backend (currentlysqlite3)database.sqlite3.filename— Path to the SQLite database filedatabase.sqlite3.timeout— Query timeout in millisecondsdatabase.sqlite3.performance— Performance tuning options (WAL mode, foreign keys, etc.)password.algorithm— Password hashing algorithm (currentlyargon2id)password.options— Argon2id configuration (memory cost in KiB, time cost iterations, parallelism level)
Database Initialization
The database is automatically initialized on first creation with:
userstable — Stores user accounts withemailandpassword(hashed) fields- Admin user — Created automatically with email
admin@delete.meand passworddeleteme(hashed with argon2id)
Database initialization is idempotent and runs only once when the database file is first created. The admin user is seeded only if no users exist.
Password Security
Passwords are hashed using Argon2id (configured in config.json). Crypto utilities are available in src/lib/crypto.js for hashing and verification.