Backend for Strascrous | Mirror from https://github.com/Strascrous/API
  • TypeScript 96.3%
  • Dockerfile 3.7%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-12 17:45:49 +01:00
.github/workflows feat: docker 2026-11-12 17:45:49 +01:00
src feat: add lontitude and latitude to restaurant data 2026-11-08 01:55:25 +01:00
.dockerignore feat: docker 2026-11-12 17:45:49 +01:00
.env.example chore: README 2026-11-08 17:54:46 +01:00
.gitignore chore(gitignore): dist 2026-11-01 23:28:07 +01:00
bun.lock feat: restaurant details 2026-11-07 22:37:42 +01:00
docker-compose.yml feat: docker 2026-11-12 17:45:49 +01:00
Dockerfile feat: docker 2026-11-12 17:45:49 +01:00
LICENSE chore: LICENSE 2026-11-08 17:11:11 +01:00
package-lock.json feat: docker 2026-11-12 17:45:49 +01:00
package.json feat: restaurant details 2026-11-07 22:37:42 +01:00
pnpm-workspace.yaml chore: initial commit 2026-10-13 13:31:35 +02:00
README.md chore(README): remove typescript mention 2026-11-08 18:33:32 +01:00
tsconfig.json chore: initial commit 2026-10-13 13:31:35 +02:00

Strascrous API

API pour consulter les restaurants, cafétérias et menus CROUS. Elle récupère les données de CROUS Mobile et les met en cache.

Prérequis

  • Node.js 22+ recommandé
  • Git
  • Une instance Valkey

Installation

npm install

Copier le fichier d’exemple, puis adapter les valeurs à votre environnement :

cp .env.example .env
npm run dev

Le serveur démarre sur http://localhost:3000.

Production

npm run build
npm start

npm start ne charge pas .env. Fournir les variables via l’environnement ou lancer :

node --env-file=.env dist/index.js

Variables d'environnement

Variable Description Exemple
VALKEY_URL URL de connexion à Valkey valkey://127.0.0.1:6379
VALKEY_APP_ID Préfixe des clés de cache de l’application strascrous-api

API

Route Description
/ État du serveur HTTP
/cities Villes prises en charge
/restaurants?city=<cityId> Restaurants d’une ville
/restaurants/:id Menus d’un restaurant

Organisation du projet

src/
├── index.ts                  # Démarrage du serveur
├── crous/                    # Données CROUS
├── helpers/                  # Utilitaires
├── infrastructure/           # Connexion à Valkey
├── repositories/             # Gestion du cache
├── routes/                   # Routes HTTP
└── services/                 # Logique métier

Licence

Ce projet est sous licence MIT.