Skylarks-Next

New experimental website/progressive web app for the website of the Berlin Skylarks Baseball & Softball Club. Built with Pocketbase, SvelteKit, Skeleton UI and Tailwind CSS.

Concept / Background

As of now, different types of data are being processed in different backends:

• The main backend Baseball & Softball Manager / BSM of the German Baseball & Softball Federation (DBV).
  • Everything related to organised play is processed there (clubs, games, leagues, teams, player, stats)
  • Accessed via REST API
  • External: no club access to any internal logic
• The current Skylarks website, served as a TYPO3 CMS website ( PHP-based).
  • Processes mostly typical CMS content (articles, info pages), but also additional team data that is distinct from BSM data: club teams, player profiles (with more data than what is available in BSM), training times, game reports
  • Mainly displayed in the TYPO3 frontend directly, but is also partly accessible via REST API
  • Internal: custom-built, full club access

Project goal

• collect data from all relevant sources and displays it in a user-friendly way
• Progressive Web App with mobile-first design
• provide backend and frontend logic to carry out team organisation tasks (practice and game attendance, teams and members, stats)
• central hub for team activities

Project requirements

• basic familiarity with the concepts of SvelteKit and Svelte - there is an excellent official tutorial available
• basic familiarity with Go and TypeScript
• Node.js v22 or higher
• access to Berlin Skylarks environment secrets and API keys

Local Development

1. Clone the repository

git clone git@github.com:tib-baseball-softball/skylarks-fe-next.git
cd skylarks-fe-next

2. Set up environment

cp .env.dist .env

• BSM API key (from BSM user account with at the club admin scope for Berlin Skylarks)
• API Auth Header (from .env on TYPO3 host server)
• PUBLIC_TYPO3_URL can either be set to a TYPO3 dev environment running locally or the production URL

3. Get project dependencies

pnpm install`
# yarn/deno/bun could also work, untested

4. Start the dev server (watches for file changes automatically)

pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

URLs

Local/Development

• BE: http://127.0.0.1:8090/
• FE: http://localhost:5173/

Production

• BE: https://pb.berlinskylarks.de/
• FE: https://app.berlinskylarks.de/

Deployment

Fully automated via GitHub Actions, deploys on every push to branch main, excluding documentation files and folders.

Server Setup / Manual Deployment

What the GitHub Action does:

1. Build the app according to the Dockerfiles
2. Pushes docker images to Docker Hub
3. Triggers Portainer deployment via Webhook

Bugs and Problems

• Please open an issue in this repository.

Terms of use

Licensed under AGPL-3.

---

Explore other templates from The Good Docs Project. Use our feedback form to give feedback on this template.

---