fix: ci
This commit is contained in:
36
README.md
36
README.md
@@ -11,6 +11,8 @@ A modern, production-ready template for building static websites with Svelte 5,
|
||||
- 📝 **TypeScript** - Type safety out of the box
|
||||
- 🧪 **Testing Suite** - Vitest for unit tests, Playwright for E2E
|
||||
- 📏 **Code Quality** - ESLint + Prettier configured
|
||||
- 🔒 **Security** - Semgrep static analysis + Bun audit
|
||||
- 🤖 **Dependencies** - Renovate for automated updates
|
||||
- 🐳 **Docker Ready** - Production nginx container
|
||||
- 🚀 **Static Generation** - Optimized for deployment anywhere
|
||||
|
||||
@@ -22,6 +24,14 @@ A modern, production-ready template for building static websites with Svelte 5,
|
||||
# Install dependencies
|
||||
bun install
|
||||
|
||||
# Install Playwright browsers (for E2E tests)
|
||||
just install-browsers
|
||||
# OR: bunx playwright install
|
||||
|
||||
# Install system dependencies for Playwright (Linux/WSL)
|
||||
just install-deps
|
||||
# OR: sudo bunx playwright install-deps
|
||||
|
||||
# Start development server
|
||||
bun run dev
|
||||
```
|
||||
@@ -111,14 +121,30 @@ Production nginx configuration in `nginx.conf` includes:
|
||||
- Security headers
|
||||
- SPA routing support
|
||||
|
||||
## Deployment
|
||||
## CI/CD & Deployment
|
||||
|
||||
### GitHub Actions / Gitea Actions
|
||||
|
||||
Single workflow (`.github/workflows/ci.yml`) that runs:
|
||||
|
||||
- **Tests & Linting** - Full CI pipeline with Just commands
|
||||
- **Security Scanning** - Semgrep static analysis + Bun audit
|
||||
- **Docker Build** - Pushes to your container registry
|
||||
|
||||
**Required Secrets/Variables:**
|
||||
|
||||
- `DOCKER_REGISTRY` - Your container registry URL
|
||||
- `DOCKER_REPOSITORY` - Your repository path
|
||||
- `DOCKER_USERNAME` / `DOCKER_PASSWORD` - Registry credentials
|
||||
- `SEMGREP_APP_TOKEN` - Optional for advanced Semgrep features
|
||||
|
||||
### Deployment Options
|
||||
|
||||
This template generates a static site that can be deployed to:
|
||||
|
||||
- **Static Hosts**: Netlify, Vercel, GitHub Pages
|
||||
- **Docker**: Any container platform (production nginx setup)
|
||||
- **CDN**: Any CDN with the built files
|
||||
- **Traditional Hosting**: Any web server
|
||||
- **Container Platforms** - Docker with nginx (recommended)
|
||||
- **Static Hosts** - Netlify, Vercel, any CDN
|
||||
- **Traditional Hosting** - Any web server
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user