This commit is contained in:
Jens
@@ -1,205 +1,183 @@
|
||||
# VacatureRadar
|
||||
|
||||
VacatureRadar is een persoonlijke, vrijwel autonome vacature-assistent voor toegestane publieke werkgeversbronnen, publieke ATS-pagina's, RSS/Atom en vacaturemails. De applicatie verzamelt vacatures, normaliseert en dedupliceert ze, past harde filters toe, berekent een uitlegbare matchscore en presenteert vacatures, skillsvraag, werkgevers, opvolging en bronstatus in een Stitch-gebaseerde Intelligence Cockpit.
|
||||
**Van vacature-overload naar een kleine, uitlegbare selectie die bij jou past.**
|
||||
|
||||
De repository bevat zowel een **werkende MVP-kern** als de volledige product-, architectuur-, UX-, beveiligings-, operationele en agentische overdrachtsdocumentatie om het project verder autonoom af te bouwen.
|
||||
VacatureRadar is een persoonlijke vacature-assistent voor België. De applicatie volgt toegestane werkgeversbronnen, ATS-pagina’s, feeds en vacaturemails, verwijdert dubbels en irrelevante resultaten en rangschikt de overblijvende kansen tegen jouw zoekprofiel. Jij behoudt altijd de controle: VacatureRadar helpt zoeken en opvolgen, maar solliciteert nooit automatisch.
|
||||
|
||||
## Huidige status
|
||||
|
||||
|
||||
Reeds geïmplementeerd:
|
||||
## Voor wie is dit?
|
||||
|
||||
- Django 5.2-modulaire monoliet met de volledige Nederlandstalige, responsive dark/light Stitch Intelligence Cockpit;
|
||||
- PostgreSQL in productie en SQLite voor lokale ontwikkeling;
|
||||
- Celery-worker en scheduler via Redis;
|
||||
- veilige HTTP-fetcher met domeinbeleid, redirecthercontrole, contentlimieten en SSRF-blokkering;
|
||||
- JSON-LD `JobPosting`, generieke HTML-, RSS/Atom- en vacaturemailparsers;
|
||||
- normalisatie, herkomstbewijs, vacatureversies en idempotente opslag;
|
||||
- exacte en fuzzy deduplicatie;
|
||||
- deterministische kenmerken, harde uitsluitregels en uitlegbare scoring;
|
||||
- zoekprofielen met revisiehistoriek en begrensde feedbackaanpassing;
|
||||
- dagelijkse digests, vacaturelevenscyclus, auditbare sollicitatiepipeline en activiteitstijdlijn;
|
||||
- werkgeversintelligence, persoonlijke skillsradar en eerlijke operationele automatiseringsstatus;
|
||||
- optionele lokale Ollama-analyse met prompt-injectionguardrails;
|
||||
- Docker Compose voor lokaal gebruik en een Unraid-variant;
|
||||
- tests, fixtures, CI, back-up-/herstelscripts en healthchecks.
|
||||
VacatureRadar is bedoeld voor één persoon of een eigen, afgeschermde installatie die:
|
||||
|
||||
Nog niet als productievoltooid beschouwd:
|
||||
- meerdere vacaturebronnen wil volgen zonder iedere site dagelijks te openen;
|
||||
- alleen aantoonbaar relevante vacatures wil beoordelen;
|
||||
- wil begrijpen waarom een vacature wel of niet past;
|
||||
- sollicitaties, deadlines en opvolging op één plek wil bewaren;
|
||||
- lokale controle over profiel-, vacature- en brondata belangrijk vindt.
|
||||
|
||||
- periodieke menselijke voorwaardenreview voor bijkomende live werkgeversbronnen;
|
||||
- productiespecifieke secrets, mailboxcredentials, domein/TLS en containerregistry.
|
||||
## Zo gebruik je VacatureRadar
|
||||
|
||||
Deze punten staan als uitvoerbare taken in [`docs/ai/BACKLOG.yaml`](docs/ai/BACKLOG.yaml). Externe credentials blokkeren nooit de rest van het werk: taken worden met mocks en interfaces afgewerkt en daarna als `blocked-external` gedocumenteerd waar echte configuratie nodig is.
|
||||
1. **Stel je radar in.** Kies rollen, skills, regio, afstand, werkmodel en harde grenzen.
|
||||
2. **Laat toegestane bronnen verwerken.** De radar ontdekt, haalt op, normaliseert en dedupliceert vacatures volgens bronbeleid en SSRF-beveiliging.
|
||||
3. **Beoordeel de beste signalen.** Iedere match toont score, datakwaliteit, positieve signalen en aandachtspunten.
|
||||
4. **Leer van de markt.** De Skillsradar laat zien welke technologieën terugkomen en waar je profiel dekking heeft.
|
||||
5. **Volg acties op.** Bewaar interessante vacatures, beheer sollicitatiedossiers en houd gesprekken en deadlines bij.
|
||||
6. **Controleer de werking.** Het Automation center maakt bronruns, pipelinegezondheid en onbekende runtime-informatie zichtbaar.
|
||||
|
||||
## Frontend en visuele validatie
|
||||
## Wat zit erin?
|
||||
|
||||
De enige normale browserfrontend is de server-rendered Stitch Intelligence Cockpit. Alle negen referentieschermen zijn aan echte Django-data gekoppeld; er is geen SPA, runtime-CDN, demo-KPI of oude parallelle shell. De ontwerpcontracten en gemotiveerde afwijkingen staan in:
|
||||
| Onderdeel | Wat je eraan hebt |
|
||||
|---|---|
|
||||
| Dagoverzicht | Prioriteiten, beste matches, open trajecten en radarstatus in één beeld |
|
||||
| Vacatureverkenner | Zoeken en filteren met een uitlegbare detailanalyse naast de resultaten |
|
||||
| Skillsradar | Actuele marktvraag naast de skills uit je eigen profiel |
|
||||
| Sollicitatiepipeline | Dossiers, status, notities, deadlines en een auditbare tijdlijn |
|
||||
| Bronnenbeheer | Veilige bronconfiguratie, gezondheid, handmatige import en mailboxkoppelingen |
|
||||
| Automatisering | Eerlijke 24-uursmetingen; niet-gemeten informatie blijft expliciet onbekend |
|
||||
|
||||
- [`STITCH_FRONTEND_CONTRACT.md`](docs/design/STITCH_FRONTEND_CONTRACT.md);
|
||||
- [`STITCH_INTEGRATION_PLAN.md`](docs/design/STITCH_INTEGRATION_PLAN.md);
|
||||
- [`STITCH_INTEGRATION_REPORT.md`](docs/design/STITCH_INTEGRATION_REPORT.md).
|
||||
## Productbeelden
|
||||
|
||||
De elf desktop-/mobielbeelden staan in `artifacts/visual-validation/` en zijn uitgesloten van de productiecontainer. De browsermatrix bestrijkt 360 tot 2560 px.
|
||||
De beelden hieronder komen uit de lokale demo-omgeving. De getoonde cijfers zijn omgevingsdata, geen marketingclaims.
|
||||
|
||||
Release-productiepad:
|
||||
| Vacatureverkenner | Automatisering |
|
||||
|---|---|
|
||||
|  |  |
|
||||
|
||||
- `./scripts/release_verify.sh` bouwt de smoke-, backup/restore- en artifactcontrole;
|
||||
- [`docs/operations/UNRAID_DEPLOYMENT.md`](docs/operations/UNRAID_DEPLOYMENT.md) bevat een expliciet upgrade/rollbackpad met releaseartefacten.
|
||||
<p align="center">
|
||||
<img src="docs/screenshots/readme/profile-mobile-light.png" width="390" alt="Mobiel zoekprofiel van VacatureRadar">
|
||||
</p>
|
||||
|
||||
## Snelste start voor Codex
|
||||
## Snel starten
|
||||
|
||||
Open de uitgepakte repository als project en geef Codex deze opdracht:
|
||||
### Optie 1 — lokale demo
|
||||
|
||||
```text
|
||||
Lees CODEX_START_HERE.md en AGENTS.md volledig. Voer daarna het autonome uitvoeringsprotocol uit. Werk alle taken met status ready in docs/ai/BACKLOG.yaml op volgorde af. Vraag geen productbeslissingen; gebruik de vastgelegde defaults. Wanneer een extern secret, account of live bronreview ontbreekt, implementeer en test de interface met fixtures, markeer uitsluitend dat externe deel als blocked-external en ga meteen door met de volgende taak. Stop pas nadat alle ready taken done zijn en scripts/codex_verify.sh volledig slaagt.
|
||||
```
|
||||
|
||||
De repository-instructies staan in [`AGENTS.md`](AGENTS.md). De handmatige startpagina staat in [`CODEX_START_HERE.md`](CODEX_START_HERE.md).
|
||||
|
||||
## Lokale quickstart
|
||||
|
||||
Vereisten: Python 3.12 of 3.13 en `uv`.
|
||||
Vereisten: Python 3.12 of 3.13, [`uv`](https://docs.astral.sh/uv/) en Git Bash op Windows.
|
||||
|
||||
```bash
|
||||
./scripts/codex_bootstrap.sh
|
||||
uv run python manage.py runserver 0.0.0.0:8080
|
||||
```
|
||||
|
||||
Het bootstrap-script:
|
||||
|
||||
1. maakt alleen wanneer nodig een lokale `.env` aan;
|
||||
2. installeert exact de gelockte dependencies;
|
||||
3. voert migraties uit;
|
||||
4. maakt demo-inhoud aan;
|
||||
5. draait lint, systeemchecks, migratiecheck, tests en taakledgervalidatie.
|
||||
|
||||
Bij een door het script aangemaakte ontwikkelomgeving is de tijdelijke login:
|
||||
Open daarna [http://127.0.0.1:8080](http://127.0.0.1:8080). Wanneer het bootstrap-script de ontwikkelomgeving heeft aangemaakt, kun je lokaal aanmelden met:
|
||||
|
||||
```text
|
||||
admin / codex-local-only
|
||||
```
|
||||
|
||||
Gebruik die nooit buiten lokale ontwikkeling.
|
||||
Het bootstrap-script maakt zo nodig `.env`, installeert de gelockte dependencies, voert migraties uit, laadt veilige demodata en draait de kwaliteitsgates. Deze tijdelijke login is uitsluitend voor lokale ontwikkeling; wijzig of verwijder hem voordat de installatie vanaf een ander toestel bereikbaar is.
|
||||
|
||||
## Docker Compose
|
||||
### Optie 2 — Docker Compose
|
||||
|
||||
Vereisten: Docker met Compose v2 en Bash.
|
||||
|
||||
```bash
|
||||
APP_HOST=localhost APP_SCHEME=http bash scripts/deploy_docker.sh
|
||||
```
|
||||
|
||||
De webinterface luistert op `0.0.0.0:1226` (containerpoort `8080`). Voor een one-shot deploy kun je nu draaien:
|
||||
Open daarna [http://127.0.0.1:1226](http://127.0.0.1:1226). Het deployscript vult ontbrekende lokale `.env`-waarden met sterke gegenereerde defaults, start PostgreSQL, Redis, Django, de worker en scheduler en controleert de health-endpoints.
|
||||
|
||||
```bash
|
||||
APP_HOST=localhost APP_SCHEME=http bash scripts/deploy_docker.sh
|
||||
```text
|
||||
http://127.0.0.1:1226/health/ready/
|
||||
http://127.0.0.1:1226/health/live/
|
||||
```
|
||||
|
||||
De script zet ontbrekende `.env`-waarden automatisch met sterke defaults (secrets, database-wachtwoord, admin-credentials, ports) en start direct de volledige Docker-stack. Daarna:
|
||||
Gebruik voor een bestaande installatie geen nieuwe gegenereerde `.env`: bewaar de huidige secrets en databasegegevens. Zie [lokale ontwikkeling](docs/operations/LOCAL_DEVELOPMENT.md) of [Unraid-deployment](docs/operations/UNRAID_DEPLOYMENT.md) voor het volledige pad.
|
||||
|
||||
- `http://127.0.0.1:1226/health/ready/`
|
||||
- `http://127.0.0.1:1226/health/live/`
|
||||
## Eerste configuratie
|
||||
|
||||
Zet voor publieke productie:
|
||||
- `APP_HOST=<jouw-domein>`
|
||||
- `APP_SCHEME=https`
|
||||
- `DJANGO_DEBUG=0`
|
||||
- `SESSION_COOKIE_SECURE=1`
|
||||
- `CSRF_COOKIE_SECURE=1`
|
||||
- `SECURE_SSL_REDIRECT=1`
|
||||
Na de eerste login:
|
||||
|
||||
De script blijft geen handmatige invulstappen voor compose vereisen; pas deze omgevingsvariabelen aan vóór eerste deploy.
|
||||
1. Open **Zoekprofiel** en stel regio, radius, rollen, skills en werkvoorkeuren in.
|
||||
2. Open **Bronnen** en activeer alleen bronnen waarvan beleid en voorwaarden beoordeeld zijn.
|
||||
3. Configureer optioneel een eigen vacaturemailbox; credentials worden niet in de repository opgeslagen.
|
||||
4. Controleer **Automatisering** voordat je op onbemande verwerking vertrouwt.
|
||||
5. Verifieer in productie altijd HTTPS, back-ups, herstel en healthchecks.
|
||||
|
||||
## Push-to-deploy via Gitea
|
||||
Belangrijke productie-instellingen:
|
||||
|
||||
Er is een `.gitea/workflows/deploy.yml` toegevoegd voor automatisch deployen op elke push naar `main` en `master`.
|
||||
```dotenv
|
||||
APP_HOST=vacatures.example.be
|
||||
APP_SCHEME=https
|
||||
DJANGO_DEBUG=0
|
||||
SESSION_COOKIE_SECURE=1
|
||||
CSRF_COOKIE_SECURE=1
|
||||
SECURE_SSL_REDIRECT=1
|
||||
```
|
||||
|
||||
Wat je nodig hebt:
|
||||
Publiceer poort `1226` niet rechtstreeks op het internet. Gebruik een beheerde reverse proxy met TLS en volg de checklist in [UNRAID_DEPLOYMENT.md](docs/operations/UNRAID_DEPLOYMENT.md).
|
||||
|
||||
- éénmalige setup van een **self-hosted Gitea-runner** op je server met Docker-toegang
|
||||
## Eerlijke grenzen
|
||||
|
||||
Daarna doet elke push automatisch:
|
||||
VacatureRadar:
|
||||
|
||||
- checkout van de repo op de runner
|
||||
- `bash scripts/deploy_docker.sh` op de server
|
||||
- automatische healthcheck + `collectstatic`
|
||||
- logt niet automatisch in op vacaturesites en omzeilt geen CAPTCHA of rate limit;
|
||||
- crawlt denylistplatformen niet rechtstreeks;
|
||||
- behandelt HTML, e-mail en modeloutput altijd als onbetrouwbare data;
|
||||
- laat iedere URL en redirect door bronbeleid en SSRF-validatie gaan;
|
||||
- past deterministische harde regels toe vóór optionele AI-analyse;
|
||||
- verstuurt nooit automatisch een sollicitatie;
|
||||
- toont ontbrekende of niet-gemeten informatie als onbekend in plaats van die te simuleren.
|
||||
|
||||
De workflow verwacht geen host/SSH-repo secrets uit het Actions-configuratiescherm.
|
||||
Lees vóór productiegebruik [SECURITY.md](SECURITY.md) en het [threat model](docs/quality/THREAT_MODEL.md).
|
||||
|
||||
Zie [Gitea push-to-deploy](docs/operations/GITEA_DEPLOYMENT.md) voor de exacte serverconfiguratie.
|
||||
## Ontwikkelen en verifiëren
|
||||
|
||||
## Zelf een schone overdrachts-ZIP maken
|
||||
De kern is een server-rendered Django 5.2-modulaire monoliet met PostgreSQL, Redis/Celery en een lokale dark/light-interface zonder runtime-CDN of SPA-afhankelijkheid. SQLite wordt gebruikt voor lokale tests.
|
||||
|
||||
```bash
|
||||
uv sync --frozen
|
||||
uv run python manage.py migrate
|
||||
uv run python manage.py runserver 0.0.0.0:8080
|
||||
```
|
||||
|
||||
Voer vóór iedere oplevering de volledige gate uit:
|
||||
|
||||
```bash
|
||||
./scripts/codex_verify.sh
|
||||
```
|
||||
|
||||
Die controleert formatting, lint, Django-configuratie, migraties, de volledige offline testset, minimaal 70% branch-aware dekking, documentatie en de taakledger. Bij wijzigingen aan de frontend controleer je daarnaast toetsenbordgebruik, dark/light en minimaal 360 px plus een gangbare desktopbreedte.
|
||||
|
||||
## Beheer en deployment
|
||||
|
||||
- [Lokaal ontwikkelen](docs/operations/LOCAL_DEVELOPMENT.md)
|
||||
- [Docker en Unraid uitrollen](docs/operations/UNRAID_DEPLOYMENT.md)
|
||||
- [Push-to-deploy met Gitea](docs/operations/GITEA_DEPLOYMENT.md)
|
||||
- [Operationeel runbook](docs/operations/RUNBOOK.md)
|
||||
- [Back-up en herstel](docs/operations/BACKUP_RESTORE.md)
|
||||
|
||||
Een overdrachtsarchief zonder secrets, lokale databases of caches maak en controleer je met:
|
||||
|
||||
```bash
|
||||
uv run python scripts/package_project.py ../VacatureRadar_Project.zip
|
||||
uv run python scripts/verify_package.py ../VacatureRadar_Project.zip
|
||||
```
|
||||
|
||||
Het packaging-script sluit `.env`, virtuele omgevingen, caches, lokale databases, logs, media en back-ups uit. In de ZIP staat `PROJECT_MANIFEST.json` met grootte en SHA-256 per bestand.
|
||||
|
||||
## Kwaliteitsgates
|
||||
|
||||
```bash
|
||||
./scripts/codex_verify.sh
|
||||
```
|
||||
|
||||
De gate vereist:
|
||||
|
||||
- Ruff zonder bevindingen;
|
||||
- een geldige Django-configuratie;
|
||||
- geen ontbrekende migraties;
|
||||
- alle tests geslaagd;
|
||||
- minimaal 70% branch-aware codedekking;
|
||||
- een geldige machineleesbare backlog.
|
||||
|
||||
## Repositorykaart
|
||||
|
||||
```text
|
||||
apps/ Django-domeinmodules
|
||||
core/ dashboard, health en beveiligingsheaders
|
||||
profiles/ zoekprofielen en revisies
|
||||
sources/ bronbeleid, fetcher, adapters en IMAP
|
||||
jobs/ normalisatie, dedupe, scoring en sollicitaties
|
||||
notifications/ digest-outbox en verzending
|
||||
config/ Django/Celery-configuratie
|
||||
config-data/ voorbeeldprofielen en bronbeleid
|
||||
fixtures/ deterministische parser- en integratietestdata
|
||||
templates/ + static/ server-rendered interface en designimplementatie
|
||||
docs/ alle product-, technische en operationele specificaties
|
||||
deployment/unraid/ Unraid-installatiehandleiding
|
||||
.agents/skills/ repo-eigen Codex-workflow
|
||||
scripts/ bootstrap, verificatie, back-up en beheer
|
||||
tests/ unit-, integratie- en securitytests
|
||||
apps/ Django-domeinen en bedrijfsservices
|
||||
config/ Django- en Celery-configuratie
|
||||
config-data/ Bronbeleid en gesaneerde voorbeeldconfiguratie
|
||||
fixtures/ Deterministische externe testformaten
|
||||
templates/ + static/ Server-rendered productinterface
|
||||
docs/ Product-, ontwerp-, security- en operationele documentatie
|
||||
deployment/unraid/ Unraid-installatiebestanden
|
||||
scripts/ Bootstrap, verificatie, deployment, back-up en beheer
|
||||
tests/ Unit-, integratie-, security- en browsertests
|
||||
```
|
||||
|
||||
## Veiligheidsgrenzen
|
||||
Belangrijke ingangen voor bijdragers en onderhoudsagents:
|
||||
|
||||
Vacature-inhoud, e-mailinhoud en externe HTML zijn altijd onbetrouwbare data. Ze mogen nooit instructies worden voor AI of automatisering. De applicatie:
|
||||
|
||||
- logt niet automatisch in op vacaturesites;
|
||||
- omzeilt geen CAPTCHA, rate limit of toegangscontrole;
|
||||
- scrapt denylistplatformen niet rechtstreeks;
|
||||
- solliciteert nooit automatisch;
|
||||
- bewaart alleen beperkte brondata en verwijdert ruwe documenten volgens retentie;
|
||||
- laat harde uitsluitregels niet door een taalmodel wijzigen;
|
||||
- maakt netwerktoegang opt-in per goedgekeurde bron.
|
||||
|
||||
Lees [`SECURITY.md`](SECURITY.md) en [`docs/quality/THREAT_MODEL.md`](docs/quality/THREAT_MODEL.md) vóór productiegebruik.
|
||||
|
||||
## Documentatie-ingangen
|
||||
|
||||
- [Projectoverdracht voor Codex](CODEX_START_HERE.md)
|
||||
- [Product requirements](docs/product/PRODUCT_REQUIREMENTS.md)
|
||||
- [Systeemarchitectuur](docs/architecture/SYSTEM_ARCHITECTURE.md)
|
||||
- [Datamodel](docs/architecture/DATA_MODEL.md)
|
||||
- [UX- en designspecificatie](docs/design/UX_SPEC.md)
|
||||
- [Stitch-integratieplan en schermmapping](docs/design/STITCH_INTEGRATION_PLAN.md)
|
||||
- [Bron- en adaptercontract](docs/architecture/SOURCE_ADAPTERS.md)
|
||||
- [Scoringengine](docs/architecture/SCORING_ENGINE.md)
|
||||
- [Unraid-deployment](docs/operations/UNRAID_DEPLOYMENT.md)
|
||||
- [Runbook](docs/operations/RUNBOOK.md)
|
||||
- [Bijdragen](CONTRIBUTING.md)
|
||||
- [Projectstart voor Codex](CODEX_START_HERE.md)
|
||||
- [Architectuur](docs/architecture/SYSTEM_ARCHITECTURE.md)
|
||||
- [UX- en designcontract](docs/design/STITCH_FRONTEND_CONTRACT.md)
|
||||
- [Teststrategie](docs/quality/TEST_STRATEGY.md)
|
||||
- [Traceabilitymatrix](docs/quality/TRACEABILITY_MATRIX.md)
|
||||
- [Oorspronkelijk functioneel en technisch ontwerp](docs/reference/VacatureRadar_functioneel_en_technisch_ontwerp.pdf)
|
||||
- [Verificatierapport van de aangeleverde basis](VERIFICATION_REPORT.md)
|
||||
- [Actuele projectstatus](docs/ai/PROJECT_STATE.md)
|
||||
- [Machineleesbare backlog](docs/ai/BACKLOG.yaml)
|
||||
|
||||
## Licentie
|
||||
|
||||
MIT voor de broncode. Controleer voor iedere externe vacaturebron afzonderlijk de voorwaarden, robotsregels, databankrechten en toepasselijke wetgeving. Dit project levert technisch bronbeleid, maar geen juridisch advies.
|
||||
De broncode valt onder de [MIT-licentie](LICENSE). Controleer voor iedere externe vacaturebron afzonderlijk de voorwaarden, robotsregels, databankrechten en toepasselijke wetgeving. Het project levert technisch bronbeleid, geen juridisch advies.
|
||||
|
||||
Reference in New Issue
Block a user