|
1 | | -# lightningtimer |
| 1 | +# Lightning Timer |
| 2 | + |
| 3 | +A focused, full-screen countdown timer for lightning talks, built as a static SvelteKit app. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Configurable duration with quick 3, 5, 7, and 10 minute presets |
| 8 | +- Viewport-filling countdown display |
| 9 | +- Yellow numerals for the final minute |
| 10 | +- Red numerals for the final 15 seconds |
| 11 | +- Red background with black numerals when time expires |
| 12 | +- Start, pause, resume, reset, and full-screen controls |
| 13 | +- Keyboard shortcuts: `Space` to start/pause, `R` to reset, and `S` to set the duration |
| 14 | +- Saves the selected duration in local storage |
| 15 | + |
| 16 | +## Development |
| 17 | + |
| 18 | +```sh |
| 19 | +npm install |
| 20 | +npm run dev |
| 21 | +``` |
| 22 | + |
| 23 | +## Build |
| 24 | + |
| 25 | +```sh |
| 26 | +npm run check |
| 27 | +npm run build |
| 28 | +``` |
| 29 | + |
| 30 | +The static site is generated in `build/`. |
| 31 | + |
| 32 | +## GitHub Pages deployment |
| 33 | + |
| 34 | +The workflow in `.github/workflows/deploy.yml` checks, builds, and deploys the app whenever `main` is pushed. It configures SvelteKit's base path as `/lightningtimer`, so assets work at: |
| 35 | + |
| 36 | +<https://idan.github.io/lightningtimer/> |
| 37 | + |
| 38 | +To enable the first deployment: |
| 39 | + |
| 40 | +1. Push this repository to GitHub. |
| 41 | +2. Open **Settings → Pages** in the repository. |
| 42 | +3. Under **Build and deployment**, select **GitHub Actions** as the source. |
| 43 | +4. Open the **Actions** tab to monitor the deployment. |
| 44 | + |
| 45 | +You can also run the workflow manually from **Actions → Deploy to GitHub Pages → Run workflow**. |
0 commit comments