DevBarometer

The dev job market barometer — powered by Reddit sentiment.

Table of Contents

1. Overview
2. Quick Start
3. Automation
4. Contributing
5. License

---

Overview

DevBarometer tracks the French developer job market’s mood from Reddit activity. Posts are ingested, filtered, and scored to produce a daily sentiment report, published to GitHub Pages.

Quick Start

Requirements

• Node.js >= 22 (see package.json#engines).
• OpenAI API key with billing enabled (for backend analysis).

Setup

git clone https://github.com/clementvidon/devbarometer.git
cd devbarometer
npm install

# Backend env
cp backend/.env.example backend/.env
# edit backend/.env and set OPENAI_API_KEY=sk-...

Run locally

• Backend API (Express): npm --workspace backend run dev then POST http://localhost:3000/report to update.
• Frontend (Vite): npm --workspace frontend run dev and open the printed local URL.

Useful scripts

• Project checks: npm run check (format:check, lint, type-check, test across workspaces).
• Tests: npm run test or npm run test:coverage (root) — or per workspace via npm --workspace <pkg> run test.

Automation

Daily GitHub Actions build and publish the static site. Maintainers can trigger a full update locally:

npm run generate-static   # backend: produce JSON snapshot
npm run update-site       # build frontend and deploy to GitHub Pages

---

Contributing

Contributions are welcome! Please read CONTRIBUTING.md and the repository Guidelines. Run npm run check before pushing. See docs/git_workflow.md for the suggested branching/PR process.

---

License

MIT

This project is open source and freely available under the MIT License. You are free to use, modify, and distribute it with attribution.