cesnimda
36 lines
2.4 KiB
Markdown
36 lines
2.4 KiB
Markdown
# Job Tracker documentation
|
|
|
|
This is the entry point for the current system documentation. Job Tracker (also branded Jobjakt in some UI and deployment text) is a self-hosted job-application workspace: it combines job tracking, company context, correspondence, documents, follow-up automation, and privacy-conscious AI assistance.
|
|
|
|
## System at a glance
|
|
|
|
- `job-tracker-ui/` is a statically exported Next.js 16 shell containing the React 19, TypeScript, MUI, and React Router application.
|
|
- `JobTrackerApi/` is an ASP.NET Core 9 API using EF Core 9, ASP.NET Identity, JWT/cookie authentication, SQLite by default, and MariaDB/MySQL as the server option.
|
|
- `tools/summarizer/` is a FastAPI service for local summarisation and bounded document extraction/OCR. CV generation can route through local Ollama or an explicitly enabled Gemini/Groq provider.
|
|
- Docker Compose runs the API, nginx frontend, AI service, and optional bundled Ollama. Gitea Actions builds and deploys the stack.
|
|
|
|
## Documentation map
|
|
|
|
| Area | Start here |
|
|
|---|---|
|
|
| Architecture | [Architecture overview](architecture/overview.md) |
|
|
| Frontend and UI | [Frontend guide](frontend/README.md) |
|
|
| Backend and API | [Backend guide](backend/README.md) · [API reference](backend/api.md) |
|
|
| AI | [AI guide](ai/README.md) |
|
|
| Database | [Database guide](database/README.md) |
|
|
| Authentication and security | [Security guide](security/README.md) |
|
|
| Configuration | [Configuration guide](configuration/README.md) · [Environment variables](configuration/environment-variables.md) |
|
|
| Docker and deployment | [Infrastructure guide](infrastructure/README.md) |
|
|
| Tests and quality gates | [Testing guide](testing/README.md) |
|
|
| Local development | [Development guide](development/README.md) |
|
|
| Product behavior | [Product guide](product/README.md) |
|
|
| Remaining work | [Roadmap](roadmap/README.md) |
|
|
| Decisions | [Architecture decisions](decisions/README.md) |
|
|
| Documentation maintenance | [Documentation rules](documentation-rules.md) |
|
|
|
|
## Authority and archive
|
|
|
|
The current source code and the documents linked above are authoritative. `BLOCKERS.md` remains the short operator/external-dependency handoff because repository instructions refer to it directly. Historical audits, plans, reports, and the pre-cleanup snapshot are under [`_archive/`](./_archive/); they are evidence, not current behavior.
|
|
|
|
When documentation and code disagree, code wins and the relevant document should be corrected in the same change.
|