Files
the-biergarten-app/docs/website/getting-started.md
Aaron Po de1e9ac02b Migrate Auth/Brewery/Location repositories to pure Dapper; rename Timer to RowVersion (#237)
* Integrate Spectre.Console into seed application, use async data loading

* Replace stored-procedure repositories with Dapper-based repositories

Removes the USP_* stored procedures for Auth, Location, and Brewery
data access in favour of services built with Dapper.

Adds a new Features.Locations slice and optimistic concurrency support
for the Brewery slice.

* Add new documentation for Dapper migration/database schema

* Update FluentAssertions to most recent open source ver

* Update XML doc comment in backend projects

* Modify brewery location dto to include denormalized data

* - Updated column names from 'Timer' to 'RowVersion' in schema.sql for
- Introduced new BeerPost entity and updated BreweryPost and BreweryPostLocation entities to use 'RowVersion' for concurrency.
- Modified UserAccount, UserCredential, UserVerification, City, StateProvince, and Country entities to use 'RowVersion' instead of 'Timer'.
- Updated tests and command handlers to reflect changes in concurrency token from 'Timer' to 'RowVersion'.
- Adjusted BreweryDto and BreweryDtoMapper to include 'RowVersion' and updated mapping logic accordingly.
- Ensured all repository methods and interfaces are aligned with the new concurrency handling approach.

* updates

* Add BeerStyle entity and related properties; refactor BreweryDto to remove BeerPosts

* Fix Api.Specs test failures: stale Timer column refs and missing test.user fixture

* Remove repository tests, usages of registration dto used in repo

* archive old stored procs/functions

* update stale docs

* Add instructions for generating cryptographically secure base64 secrets on macOS/Linux and Windows
2026-08-24 01:09:47 -04:00

3.3 KiB

Getting started

This guide covers local setup for the current Biergarten stack: the .NET backend in web/backend and the active React Router frontend in web/frontend.

Prerequisites

  • .NET SDK 10+
  • Node.js 18+
  • Docker Desktop or equivalent Docker Engine setup
  • Java 8+ if you want to regenerate PlantUML diagrams

1. Clone the repository

git clone https://github.com/aaronpo97/the-biergarten-app
cd the-biergarten-app

2. Configure backend environment variables

cp web/.env.example web/.env.dev

At minimum, ensure .env.dev includes valid database and token values:

DB_SERVER=sqlserver,1433
DB_NAME=Biergarten
DB_USER=sa
DB_PASSWORD=YourStrong!Passw0rd
ACCESS_TOKEN_SECRET=<generated>
REFRESH_TOKEN_SECRET=<generated>
CONFIRMATION_TOKEN_SECRET=<generated>
WEBSITE_BASE_URL=http://localhost:3000

See Environment Variables for the full list.

3. Start the backend stack

docker compose --env-file web/.env.dev -f web/docker-compose.dev.yaml up -d

This starts SQL Server, migrations, seeding, the API, and Mailpit (local dev SMTP).

Available endpoints:

4. Start the active frontend

cd web/frontend
npm install
API_BASE_URL=http://localhost:8080 SESSION_SECRET=dev-secret-change-me npm run dev

The website will be available at the local address printed by React Router dev.

Required frontend runtime variables for local work:

  • API_BASE_URL - Base URL for the .NET API
  • SESSION_SECRET - Cookie session signing secret for the website server

5. Optional: run Storybook

cd web/frontend
npm run storybook

Storybook runs at http://localhost:6006 by default.

Useful commands

Backend

docker compose --env-file web/.env.dev -f web/docker-compose.dev.yaml logs -f
docker compose --env-file web/.env.dev -f web/docker-compose.dev.yaml down
docker compose --env-file web/.env.dev -f web/docker-compose.dev.yaml down -v

Frontend

cd web/frontend
npm run lint
npm run typecheck
npm run format:check
npm run test:storybook
npm run test:storybook:playwright

Manual backend setup

If you do not want to use Docker, you can run the backend locally.

1. Set environment variables

export DB_CONNECTION_STRING="Server=localhost,1433;Database=Biergarten;User Id=sa;Password=YourStrong!Passw0rd;TrustServerCertificate=True;"
export ACCESS_TOKEN_SECRET="<generated>"
export REFRESH_TOKEN_SECRET="<generated>"
export CONFIRMATION_TOKEN_SECRET="<generated>"
export WEBSITE_BASE_URL="http://localhost:3000"

2. Run migrations and seed

cd web/backend
dotnet run --project Database/Database.Migrations/Database.Migrations.csproj
dotnet run --project Database/Database.Seed/Database.Seed.csproj

3. Start the API

dotnet run --project API/API.Core/API.Core.csproj

Legacy frontend note

The previous Next.js frontend lives in archive/next-js-web-app/ for reference only and is not the active website.

Next steps