docs: consolidate repository guides and preserve audit history
This commit is contained in:
@@ -0,0 +1,9 @@
|
||||
# Development
|
||||
|
||||
- [Getting started](getting-started.md)
|
||||
- [Conventions](conventions.md)
|
||||
- [Troubleshooting](troubleshooting.md)
|
||||
- [Configuration](../configuration/README.md)
|
||||
- [Testing](../testing/README.md)
|
||||
|
||||
Keep changes narrow, update current docs with behavior changes, and preserve unrelated work in the shared worktree.
|
||||
@@ -0,0 +1,5 @@
|
||||
# Development conventions
|
||||
|
||||
Use nullable reference types and existing EF Core/service patterns. Put authorization and ownership checks at the API boundary, keep external work bounded and reviewable, and add focused regression tests for behavior changes. Prefer the existing libraries and component conventions over new abstractions.
|
||||
|
||||
Do not edit applied migration history, reset shared databases, commit secrets, or treat an old report as current behavior. When an implementation decision matters, record it in `docs/decisions/` and link it from the relevant current guide.
|
||||
@@ -0,0 +1,17 @@
|
||||
# Getting started
|
||||
|
||||
Prerequisites: .NET SDK 9, Node.js 24/npm, Docker Compose for the container path, and Python 3.12 only when running the AI service outside Docker.
|
||||
|
||||
## Local processes
|
||||
|
||||
```powershell
|
||||
cd JobTrackerApi
|
||||
dotnet restore --locked-mode
|
||||
dotnet run
|
||||
|
||||
cd ..\job-tracker-ui
|
||||
npm ci
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Open `http://localhost:3000`; the API defaults to `http://localhost:5202`. For the full stack, create `.env` from `.env.example` and run `docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build` from the repository root. See [environment variables](../configuration/environment-variables.md).
|
||||
@@ -0,0 +1,12 @@
|
||||
# Troubleshooting
|
||||
|
||||
| Symptom | First checks |
|
||||
|---|---|
|
||||
| UI cannot reach API | Confirm API port 5202, `NEXT_PUBLIC_API_BASE_URL`, and nginx `/api` proxy configuration. |
|
||||
| Stack is running but not ready | Check backend health/readiness and database provider/connection settings; inspect sanitized logs. |
|
||||
| AI unavailable | Check `AI_SERVICE_BASE_URL`, matching `AI_SERVICE_TOKEN`, sidecar health, model/provider settings, and policy gates. |
|
||||
| Mail/reset unavailable | Check SMTP enablement, host/port/TLS, credentials, sender, and provider limits. |
|
||||
| Migration failure | Preserve the database and logs; do not delete/recreate it. Use a disposable reproduction and the migration guide. |
|
||||
| Browser test failure | Confirm the harness owns its ports and isolated database; do not point it at dev/production data. |
|
||||
|
||||
For deployment or restore incidents use [infrastructure](../infrastructure/README.md) and the root [BLOCKERS.md](../../BLOCKERS.md).
|
||||
Reference in New Issue
Block a user