Repository Guidelines

Project Structure & Module Organization

This repository is currently a minimal skeleton with no source or test directories committed yet. As you add code, follow a clear top-level layout such as:

src/ for application code
tests/ for automated tests
scripts/ for maintenance or build utilities
docs/ for documentation and design notes

Keep new directories shallow and self-explanatory.

Build, Test, and Development Commands

Frontend (Vue, Vite):
- cd src/frontend && npm install installs dependencies.
- cd src/frontend && npm run dev starts the dev server.
- cd src/frontend && npm run build creates a production build.
- cd src/frontend && npm run preview previews the production build.
API (.NET):
- dotnet restore src/api restores NuGet dependencies.
- dotnet build src/api builds the API.
- dotnet run --project src/api runs the API.
Dev shell:
- scripts/dev-tmux.sh starts a tmux session with API and frontend windows and attaches to it, or adds windows to the current session if already inside tmux.

Coding Style & Naming Conventions

Indentation: 2 spaces for JS/Vue, 4 spaces for C#.
Naming: camelCase for JS, PascalCase for C# types and camelCase for locals.
Formatting: no tooling configured yet.

Testing Guidelines

No testing framework is configured yet.

Commit & Pull Request Guidelines

The repository has no commit history available yet, so there is no established commit message convention. When you start committing:

Use short, imperative subject lines (e.g., "Add tracker API")
Include context in the body when changes are non-trivial

For pull requests, include a brief summary, any linked issues, and screenshots for UI changes.

Configuration & Secrets

Do not commit secrets. Use environment variables and provide sample configuration files such as .env.example when needed.

1.9 KiB Raw Blame History