tudattr/kilo-cv
1
0
Fork 0
Code Issues Pull Requests 10 Actions Packages Projects Releases 5 Wiki Activity

docs: add gitleaks setup and api docs info

Browse Source
This commit is contained in:
Tuan-Dat Tran
2026-02-20 17:42:46 +01:00
parent 3d2ee7df7f
commit cbf40908a6
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -102,6 +102,30 @@ KEYCLOAK_REALM=your-realm
KEYCLOAK_CLIENT_ID=cv-admin KEYCLOAK_CLIENT_ID=cv-admin
``` ```
## Development Setup
### Pre-commit Setup
This project uses Gitleaks for secret scanning. Install it before committing:
```bash
# macOS
brew install gitleaks
# Linux
curl -sSfL https://github.com/gitleaks/gitleaks/releases/latest/download/gitleaks_linux_x64.tar.gz | tar -xz
sudo mv gitleaks /usr/local/bin/
# Windows
scoop install gitleaks
```
### API Documentation
API documentation is available at `/api/docs` when running the server.
Access the interactive Swagger UI at: `http://localhost:3001/api/docs`
## Admin Authentication ## Admin Authentication
### Simple Mode (Default) ### Simple Mode (Default)
@@ -128,6 +152,7 @@ KEYCLOAK_CLIENT_ID=cv-admin
| POST | `/api/cv/import` | Yes | Import JSON data | | POST | `/api/cv/import` | Yes | Import JSON data |
| GET | `/api/auth/config` | No | Get auth configuration | | GET | `/api/auth/config` | No | Get auth configuration |
| POST | `/api/auth/login` | No | Login with password | | POST | `/api/auth/login` | No | Login with password |
| GET | `/api/docs` | No | Swagger API documentation |
| GET | `/health` | No | Health check | | GET | `/health` | No | Health check |
## Project Structure ## Project Structure