Cauldron

A self-hosted application to help manage leftovers, meal planning, and food inventory

Table of contents

• Overview
• Requirements
• Project layout
• Setup
  • Backend
  • Frontend
• Scripts
• Testing
• API docs
• Configuration
• Contributing and security
• License

Requirements

• Git
• .NET SDK 10
• Bun (includes Node) or Node with npm
• Playwright browsers: npx playwright install before e2e tests

Project layout

• backend/Cauldron.Api: ASP.NET Core API, SQLite storage
• frontend/cauldron: Vue 3 + Vite + Bun client
• CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md, LICENSE, README.md

Setup

Backend

dotnet restore backend/Cauldron.Api/Cauldron.Api.csproj
dotnet build backend/Cauldron.Api/Cauldron.Api.csproj
dotnet run --project backend/Cauldron.Api/Cauldron.Api.csproj

The API uses SQLite at backend/Cauldron.Api/cauldron.db. Swagger UI is available when the API is running.

Frontend

cd frontend/cauldron
bun install
bun dev

Scripts

Backend

• Build: dotnet build backend/Cauldron.Api/Cauldron.Api.csproj
• Run: dotnet run --project backend/Cauldron.Api/Cauldron.Api.csproj

Frontend

• Dev server: bun dev
• Build: bun run build
• Lint: bun lint
• Unit tests: bun test:unit
• E2E tests: bun test:e2e (after npx playwright install)

Testing

Run frontend tests from frontend/cauldron. Add dotnet test when backend tests exist. Keep tests green before opening a PR.

API docs

When the backend is running, open Swagger UI at /swagger to explore routes.

Configuration

Backend settings live in backend/Cauldron.Api/appsettings.json and appsettings.Development.json. Frontend uses Vite env files if added (for example .env.local).

Contributing and security

See CONTRIBUTING.md for workflow and CODE_OF_CONDUCT.md for behavior. Report security issues through SECURITY.md.

License

This project is licensed under the terms in LICENSE.