https://github.com/peyton/sunclub
https://github.com/peyton/sunclub
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/peyton/sunclub
- Owner: peyton
- License: other
- Created: 2026-02-13T21:52:22.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2026-04-20T16:06:31.000Z (about 2 months ago)
- Last Synced: 2026-04-21T00:34:23.070Z (about 2 months ago)
- Language: Swift
- Size: 507 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Sunclub
## Source Availability and License
Sunclub is source-available, not open source. Copyright (c) 2026 Peyton
Randolph. All rights reserved.
This repository is available under the unmodified [PolyForm Strict License
1.0.0](LICENSE). The license does not permit source redistribution, binary
redistribution, sublicensing, public fork distribution, App Store or other
marketplace publication, or modified or derivative works. Commercial use is not
licensed. No trademark rights are granted. See [NOTICE](NOTICE) for the
ownership notice.
Repository layout:
- App: [app/README.md](app/README.md)
- Docs: [docs/](docs/)
- App automation: [docs/app-automation.md](docs/app-automation.md)
- TestFlight flow: [docs/testflight-release.md](docs/testflight-release.md)
The iOS app lives in [app/](app). Product and design notes live in [docs/](docs).
Tooling is pinned in [mise.toml](mise.toml).
Common setup from the repo root:
- `just bootstrap`
- `just icons`
- `just generate`
- `just build`
- `just run`
- `just web-serve`
- `just web-check`
- `just web-fmt`
- `just web-build`
- `just web-package VERSION=test`
- `just web-release-tag 1.2.3`
- `just cloudflare-status`
- `just cloudflare-pages-setup`
- `just cloudflare-pages-status`
- `just cloudflare-email-setup`
- `just cloudflare-email-status`
- `just cloudflare-check`
- `just cloudkit-save-token`
- `just cloudkit-doctor`
- `just cloudkit-ensure-container`
- `just cloudkit-export-schema`
- `just cloudkit-validate-schema`
- `just cloudkit-import-schema`
- `just cloudkit-reset-dev`
- `just clean-build`
- `just clean-generated`
- `just clean`
- `just lint`
- `just fmt`
- `just test`
- `just test-unit`
- `just test-ui`
- `just test-python`
- `just ci-lint`
- `just ci-python`
- `just ci-build`
- `just appstore-env`
- `just appstore-validate`
- `just appstore-validate-strict`
- `just appstore-review-package`
- `just appstore-screenshots`
- `just appstore-archive`
- `just appstore-submit-dry-run`
- `just appstore-submit-review`
- `just appstore-send-review`
- `just release-tag 1.2.3`
- `just ci`
`just bootstrap` installs repo-local tooling into `.mise/`, syncs the Python environment into `.venv/`, prepares repo-local caches under `.cache/`, and primes Tuist's local Xcode cache service from `app/` on local machines.
Sunclub stays local-first, but the app now ships with default-on iCloud sync for revision history plus local backup export/import. Local imports stay recoverable on-device and do not change iCloud until the user explicitly publishes the imported batches from `Recovery & Changes`.
Automation is a first-class release surface. Shortcuts, Control Center, widgets, custom URL actions, and x-callback-url routes are documented in [docs/app-automation.md](docs/app-automation.md), and users can manage automation writes from Settings -> Automation.
The static public web presence lives in [web/](web). Local preview uses `just web-serve`; `just web-build` copies the checked site into `.build/web/`; `just web-package VERSION=test` writes a release tarball and checksum under `.build/releases/`.
Cloudflare Pages and Email Routing setup is tracked in [infra/cloudflare/](infra/cloudflare/) and documented in [docs/cloudflare-deployment-execplan.md](docs/cloudflare-deployment-execplan.md). Web deployment and rollback are documented in [docs/web-release.md](docs/web-release.md). Local status commands are safe without credentials; setup commands require `CLOUDFLARE_API_TOKEN`, and email setup also requires `SUNCLUB_FORWARD_TO`. GitHub web deployment requires GitHub Actions secrets `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID`.
CloudKit setup is documented in [docs/cloudkit-setup.md](docs/cloudkit-setup.md). `just cloudkit-doctor` validates that the saved token is a management token for the configured team, checks whether a signed build actually carries the expected CloudKit entitlements, and retries `cktool` schema access. `just cloudkit-ensure-container` runs the same validation and opens the relevant Apple setup pages if the container or App ID configuration is still missing.
Release automation and the dev/prod flavor split are documented in [docs/testflight-release.md](docs/testflight-release.md). In short: local `just build` / `just run` use the `SunclubDev` flavor, `just appstore-archive` uses the production `Sunclub` flavor, and pushing a `vX.Y.Z` tag through `just release-tag` triggers the TestFlight workflow. App Review submission is documented in [docs/app-store-submission.md](docs/app-store-submission.md), uses `just appstore-env` for local sensitive values, and is guarded by strict metadata plus a redacted checkpoint phrase. Web releases are separate: pushing `web/vX.Y.Z` through `just web-release-tag` creates a web GitHub Release and does not trigger the iOS release workflow.
`just clean-build` removes repo-local build artifacts and the generated workspace, `just clean-generated` additionally removes repo-local caches and environments such as `.venv`, `.mise`, `.cache`, `.config`, `.state`, and `__pycache__`, and `just clean` runs the full cleanup chain.