2.5 KiB
2.5 KiB
AGENTS.md — Balinyaar
Guidance for AI coding agents working in this repository. Read this first, then the project-specific AGENTS.md for whichever side you are editing.
What this repository is
Balinyaar is a full-stack application split into two independent projects:
| Path | Project | Stack | Detail |
|---|---|---|---|
client/ |
Web frontend | Next.js (App Router), React, TypeScript, Material UI (MUI) | client/AGENTS.md |
server/ |
Backend API | ASP.NET Core (.NET 10), Clean Architecture, CQRS, EF Core | server/AGENTS.md |
The two communicate over HTTP/JSON (and optionally gRPC). The client reads the API base URL from NEXT_PUBLIC_API_URL; the server runs on https://localhost:5002 by default.
There is no root-level build — each project is built and run on its own. client/ and server/ are not part of the same package/solution.
Working agreements
- Stay within one project per change unless the task explicitly spans both. A frontend change rarely needs server files and vice-versa.
- Match the surrounding style. Each project has its own conventions (see its
AGENTS.md). Mirror the existing patterns rather than introducing new ones. - Run the project's own checks before declaring work done:
- client:
npm run lintandnpm run type(andnpm run test:ciif tests are touched) - server:
dotnet buildanddotnet test
- client:
- Do not reintroduce template/starter scaffolding. This repo was derived from two open-source starters; their branding, demo/showcase pages, NuGet template packaging, and
_TITLE_/_DESCRIPTION_placeholders have been intentionally removed. Don't add them back. - Secrets: never commit real connection strings, keys, or tokens. Use
.env(client) andappsettings.*.json/ user-secrets (server).
Quick start
# Frontend
cd client && npm install && npm run dev # http://localhost:3000
# Backend
cd server && dotnet run --project src/API/Baya.Web.Api/Baya.Web.Api.csproj # https://localhost:5002/swagger
Naming note
The server's C# namespaces, projects, and solution file all use the Baya* prefix (e.g. Baya.Web.Api, Baya.sln). Keep new server code under the same Baya.* namespace convention.