|
42 | 42 |
|
43 | 43 | ## 🚀 Deployment Options |
44 | 44 |
|
45 | | -### Prerequisites for Helm Repository |
46 | | - |
47 | | -Before installing from the Helm repository, ensure the GitHub Pages repository is set up: |
48 | | - |
49 | | -1. **Enable GitHub Pages**: |
50 | | - - Go to your repository Settings → Pages |
51 | | - - Set Source to "Deploy from a branch" |
52 | | - - Select the `gh-pages` branch |
53 | | - - Save the settings |
54 | | - |
55 | | -2. **Trigger Chart Release**: |
56 | | - - The chart-releaser action will automatically run on pushes to `main` |
57 | | - - It will create the `gh-pages` branch and publish the chart |
58 | | - - You can manually trigger it by pushing changes to the `charts/slaking/` directory |
59 | | - |
60 | | -3. **Verify Repository**: |
61 | | - ```bash |
62 | | - # Check if the repository is available |
63 | | - curl https://elementtech.github.io/slaking/index.yaml |
64 | | - ``` |
65 | | - |
66 | 45 | ### Option 1: Helm Chart (Recommended) 🦥 |
67 | 46 |
|
68 | 47 | The easiest way to deploy Slaking is using the provided Helm chart from the GitHub Pages repository: |
@@ -288,26 +267,6 @@ helm upgrade slaking slaking/slaking \ |
288 | 267 | --reuse-values |
289 | 268 | ``` |
290 | 269 |
|
291 | | -## 🛠️ Development |
292 | | - |
293 | | -### Local Development |
294 | | - |
295 | | -```bash |
296 | | -npm run dev |
297 | | -``` |
298 | | - |
299 | | -### Testing |
300 | | - |
301 | | -```bash |
302 | | -npm test |
303 | | -``` |
304 | | - |
305 | | -### Building Docker Image |
306 | | - |
307 | | -```bash |
308 | | -npm run build |
309 | | -``` |
310 | | - |
311 | 270 | ## 🔌 API Endpoints |
312 | 271 |
|
313 | 272 | - `GET /health` - Health check (Slaking's vital signs) |
@@ -498,14 +457,6 @@ The service requires minimal permissions: |
498 | 457 | - Slack token is stored in Kubernetes Secret |
499 | 458 | - Consider using external secret management (HashiCorp Vault, AWS Secrets Manager, etc.) |
500 | 459 |
|
501 | | -## 🤝 Contributing |
502 | | - |
503 | | -1. Fork the repository |
504 | | -2. Create a feature branch |
505 | | -3. Make your changes |
506 | | -4. Add tests |
507 | | -5. Submit a pull request |
508 | | - |
509 | 460 | --- |
510 | 461 |
|
511 | 462 | ``` |
|
0 commit comments