josh/SixFlagsSuperCalendar
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README with current feature set, remove CI/CD section

Browse Source 
- Add park detail pages and ride status to description
- Replace flat park list with regional table
- Add debug command documentation
- Remove CI/CD section (Gitea Actions config docs)
- Clean up deployment section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Josh Wright
2026-04-04 12:03:32 -04:00
parent b0bbb4d465
commit ba8cd46e75
1 changed files with 29 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@@ -1,31 +1,30 @@
# Six Flags Super Calendar
A week-by-week calendar showing operating hours for all Six Flags Entertainment Group theme parks — including the former Cedar Fair parks. Data is scraped from the Six Flags internal API and stored locally in SQLite.
A week-by-week calendar showing operating hours for all Six Flags Entertainment Group theme parks — including the former Cedar Fair parks. Data is scraped from the Six Flags internal API and stored locally in SQLite. Click any park to see its full month calendar and today's ride status.
## Parks
24 theme parks across the US, Canada, and Mexico:
24 theme parks across the US, Canada, and Mexico, grouped by region:
**Six Flags branded** — Great Adventure (NJ), Magic Mountain (CA), Great America (IL), Over Georgia, Over Texas, St. Louis, Fiesta Texas (TX), New England (MA), Discovery Kingdom (CA), Mexico, Great Escape (NY), Darien Lake (NY), Frontier City (OK)
**Former Cedar Fair** — Cedar Point (OH), Knott's Berry Farm (CA), Canada's Wonderland (ON), Carowinds (NC), Kings Dominion (VA), Kings Island (OH), Valleyfair (MN), Worlds of Fun (MO), Michigan's Adventure (MI), Dorney Park (PA), California's Great America (CA)
| Region | Parks |
|--------|-------|
| **Northeast** | Great Adventure (NJ), New England (MA), Great Escape (NY), Darien Lake (NY), Dorney Park (PA), Canada's Wonderland (ON) |
| **Southeast** | Over Georgia, Carowinds (NC), Kings Dominion (VA) |
| **Midwest** | Great America (IL), St. Louis (MO), Cedar Point (OH), Kings Island (OH), Valleyfair (MN), Worlds of Fun (MO), Michigan's Adventure (MI) |
| **Texas & South** | Over Texas, Fiesta Texas (TX), Frontier City (OK) |
| **West & International** | Magic Mountain (CA), Discovery Kingdom (CA), Knott's Berry Farm (CA), California's Great America (CA), Mexico |
## Tech Stack
- **Next.js 15** (App Router, Server Components, standalone output)
- **Tailwind CSS v4** (`@theme {}` CSS variables, no config file)
- **Next.js 15** — App Router, Server Components, standalone output
- **Tailwind CSS v4** — `@theme {}` CSS variables, no config file
- **SQLite** via `better-sqlite3` — persisted in `/app/data/parks.db`
- **Playwright** — one-time headless browser run to discover each park's internal API ID
- **Six Flags CloudFront API** — `https://d18car1k0ff81h.cloudfront.net/operating-hours/park/{id}?date=YYYYMM`
## Local Development
### Prerequisites
- Node.js 22+
- npm
### Setup
**Prerequisites:** Node.js 22+, npm
```bash
npm install
@@ -40,59 +39,58 @@ Run once to discover each park's internal API ID (opens a headless browser per p
npm run discover
```
Then scrape operating hours for the full year:
Scrape operating hours for the full year:
```bash
npm run scrape
```
To force a full re-scrape (ignores the 7-day staleness window):
Force a full re-scrape (ignores the 7-day staleness window):
```bash
npm run scrape:force
```
### Debug a specific park + date
Inspect raw API data and parsed output for any park and date:
```bash
npm run debug -- --park kingsisland --date 2026-06-15
```
Output is printed to the terminal and saved to `debug/{parkId}_{date}.txt`.
### Run the dev server
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000). Navigate weeks with the `←` / `→` buttons or pass `?week=YYYY-MM-DD` directly.
Open [http://localhost:3000](http://localhost:3000). Navigate weeks with the `←` / `→` buttons, or pass `?week=YYYY-MM-DD` directly. Click any park name to open its detail page.
---
## Deployment
### Docker (standalone)
The app uses Next.js standalone output. The SQLite database is stored in a Docker volume at `/app/data`.
#### Run
```bash
docker compose up -d
```
#### Seed the database inside the container
### Seed the database inside the container
The production image includes Playwright and Chromium, so discovery and scraping can be run directly against the running container's volume.
The production image includes Playwright and Chromium, so discovery and scraping run directly against the container's volume:
```bash
# Discover API IDs for all parks (one-time, opens headless browser per park)
docker compose exec web npm run discover
# Scrape operating hours for the full year
docker compose exec web npm run scrape
```
Or as one-off containers against the named volume:
Or as a one-off against the named volume:
```bash
docker run --rm -v sixflagssupercalendar_park_data:/app/data \
gitea.thewrightserver.net/josh/sixflagssupercalendar:latest \
npm run discover
docker run --rm -v sixflagssupercalendar_park_data:/app/data \
gitea.thewrightserver.net/josh/sixflagssupercalendar:latest \
npm run scrape
@@ -100,38 +98,6 @@ docker run --rm -v sixflagssupercalendar_park_data:/app/data \
---
### CI/CD (Gitea Actions)
The pipeline is defined at [`.gitea/workflows/deploy.yml`](.gitea/workflows/deploy.yml).
**Trigger:** Push to `main`
**Steps:**
1. Checkout code
2. Log in to the Gitea container registry
3. Build and tag the image as `:latest` and `:<short-sha>`
4. Push both tags
#### Required configuration in Gitea
| Type | Name | Value |
|------|------|-------|
| Variable | `REGISTRY` | Registry hostname — `gitea.thewrightserver.net` |
| Secret | `REGISTRY_TOKEN` | A Gitea access token with `package:write` scope |
Set these under **Repository → Settings → Actions → Variables / Secrets**.
#### Upstream remote
```bash
git remote add origin https://gitea.thewrightserver.net/josh/SixFlagsSuperCalendar.git
git push -u origin main
```
---
## Data Refresh
The scrape job skips any park+month combination scraped within the last 7 days. To keep data current, run `npm run scrape` (or `scrape:force`) on a schedule — weekly is sufficient for a season calendar.
Parks and months not yet in the database show a `—` placeholder in the UI. Parks with no hours data on a given day show "Closed".
The scraper skips any park + month combination scraped within the last 7 days. Run `npm run scrape` on a weekly schedule to keep data current. Parks or months not yet in the database show a `—` placeholder; parks with no open days in the displayed week are hidden from the calendar automatically.