feat: initial scaffold — MVP catalogue de données d'API
- Backend NestJS : CRUD api_entries + categories, upload YAML multi-fichiers, génération docs AsyncAPI (@asyncapi/cli@6.0.0) et OpenAPI (redocly) - Fix: route wildcard GET /api/apis/:id/*path pour servir les assets statiques (CSS/JS) générés par AsyncAPI HTML template (contournement bug path-to-regexp v8) - Frontend Angular 19 : pages catalog, browse, api-detail, doc-viewer, upload (DSFR) - Seeder de données de démo (idempotent) - Docker Compose dev + Dockerfiles + manifests K8s - Documentation : README, architecture, référence API REST Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
This commit is contained in:
24
documentation/README.md
Normal file
24
documentation/README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# Datacat
|
||||
|
||||
A data catalog for API documentation. Import YAML files (AsyncAPI / OpenAPI) and generate
|
||||
HTML documentation automatically via AsyncAPI CLI and Redocly CLI.
|
||||
|
||||
## Quick start
|
||||
|
||||
```bash
|
||||
# Dev (Docker)
|
||||
pnpm run dev
|
||||
|
||||
# Dev (local)
|
||||
cd back && pnpm run start:dev
|
||||
cd front-public && pnpm run start
|
||||
```
|
||||
|
||||
## URLs (dev)
|
||||
|
||||
- Frontend: https://datacat.dev.chmod777.dev
|
||||
- API: https://api.datacat.dev.chmod777.dev
|
||||
- Local frontend: http://localhost:4200
|
||||
- Local API: http://localhost:3000
|
||||
|
||||
## See CLAUDE.md for the full implementation guide.
|
||||
Reference in New Issue
Block a user