https://github.com/obartra/countdown
Countdown Timer
https://github.com/obartra/countdown
countdown countdown-application countdown-clock countdown-javascript countdown-timer
Last synced: about 2 months ago
JSON representation
Countdown Timer
- Host: GitHub
- URL: https://github.com/obartra/countdown
- Owner: obartra
- License: mit
- Created: 2023-10-21T00:03:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-22T00:27:45.000Z (3 months ago)
- Last Synced: 2025-12-23T00:41:08.607Z (3 months ago)
- Topics: countdown, countdown-application, countdown-clock, countdown-javascript, countdown-timer
- Language: TypeScript
- Homepage: https://cronos.love
- Size: 3.62 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⏳ Countdown
Simple, customizable countdown with shareable short URLs, admin review tools, and theming.
## Usage
Create a countdown by visiting the editor (root path) and filling in the form, or by providing URL parameters:
- `time` (required, ISO UTC like `2025-01-01T00:00:00Z`)
- `title`, `description`, `footer`, `complete`
- `color` (text color), `bgcolor` (background color)
- `image` (`provider:id`, e.g., `openverse:` or `tenor:`)
Publishing generates a short URL `/v/:slug` that can be viewed without loading the editor. Protected slugs require a password to edit or delete. Admins can review reports and clear/delete via privileged headers.
## Samples
## Project structure
- `src/` — React app (editor/viewer, theming, UI components)
- `netlify/functions/` — API endpoints (`/publish`, `/v/:slug`, `/admin-stats`, `/api/admin/reports`, `/api/admin/reports/:slug`, `/report`, etc.)
- `cypress/` — E2E tests
- `docs/design/` — feature designs
- `docs/pr/` — PR plans derived from designs
## Scripts
- `pnpm start` — Vite dev server + Netlify functions (`PORT` default 8080, `FUNCTIONS_PORT` default 8888 via `scripts/serve-functions.js`)
- `pnpm dev` — Vite dev server only
- `pnpm build` — Build app to `dist/`
- `pnpm preview` — Preview production build
- `pnpm test` — Unit/integration tests (Vitest)
- `pnpm bundle:check` — Assert bundle size split (requires prior `pnpm build`)
- `pnpm lint` — ESLint
- `pnpm types` — Typecheck
- `pnpm test:e2e` — Cypress against local dev + functions (requires available ports 4173/8889)
CI runs `pnpm bundle:check` automatically after `pnpm build`.
## Environment
- `ADMIN_SECRET` — Required for admin endpoints (`/api/admin/reports`, `/api/admin/reports/:slug`, `/admin-stats`, admin override delete)
- `VITE_TENOR_CLIENT_KEY`, `VITE_IMAGE_API_KEY_TENOR` — Tenor image search
- `VITE_OPENVERSE_BASE` — OpenVerse API base (for image search)
- `COUNTDOWN_STORAGE_DIR` — Override local blob shim root (defaults to `/tmp/.netlify/published-data` in Netlify functions, `.netlify/published-data` when running tests locally)
- `COUNTDOWN_STORAGE_DRIVER` — Optional override for storage (`fs` or `blobs`)
- `COUNTDOWN_BLOBS_SITE_ID` — Netlify site ID for manual Blobs configuration
- `COUNTDOWN_BLOBS_TOKEN` — Netlify API token for manual Blobs configuration
- `COUNTDOWN_BLOBS_API_URL` — Optional Netlify API base URL override
## API endpoints (Netlify functions)
- `POST /publish` — Create/update countdowns (short slugs)
- `GET /v/:slug` — Fetch published payload + metadata
- `DELETE /v/:slug` — Delete published countdown (owner password or `x-admin-override`)
- `POST /v/:slug/report` — Submit a report (rate limited)
- `GET /api/admin/reports` — List reported slugs (requires `x-admin-secret`)
- `GET /api/admin/published` — List published slugs with metadata (paginated, requires `x-admin-secret`)
- `PATCH /api/admin/reports/:slug` — Mark reviewed
- `DELETE /api/admin/reports/:slug` — Clear reports (optional `purgeBlobs=true`)
- `GET /admin/stats` — Admin stats (requires `x-admin-secret`)
Admin UI:
- `/admin` — landing hub for admin tools (requires admin secret, includes a Settings card to clear the session secret)
- `/admin/reports` — toggles between reported and published slugs, calls `/api/admin/reports*` and `/api/admin/published`
## Dev setup
Requires Node 25.2.x (see `.nvmrc`) and pnpm 10+.
```sh
pnpm install
# Optional helpers used in scripts on Linux/macOS
sudo apt-get install jq # Ubuntu/Debian
brew install jq # macOS
```
Local dev with functions:
```sh
pnpm start
# App: http://localhost:8080 (or PORT)
# Functions: http://localhost:8888/.netlify/functions (or FUNCTIONS_PORT)
```
Tests:
```sh
pnpm types
pnpm lint
pnpm test
npm run test:e2e # requires free ports 4173/8889
```
## Deployment
Build output lives in `dist/`. Netlify Functions reside in `netlify/functions/`. Set `ADMIN_SECRET` and image API keys in your deploy environment. Production uses Netlify Blobs; local dev uses the `.netlify/published-data` shim. Refer to design docs in `docs/design/` and PR briefs in `docs/pr/` for feature-specific details.