diff --git a/README.md b/README.md index 0dc6454..74396b2 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,30 @@ KEYCLOAK_REALM=your-realm 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 ### Simple Mode (Default) @@ -128,6 +152,7 @@ KEYCLOAK_CLIENT_ID=cv-admin | POST | `/api/cv/import` | Yes | Import JSON data | | GET | `/api/auth/config` | No | Get auth configuration | | POST | `/api/auth/login` | No | Login with password | +| GET | `/api/docs` | No | Swagger API documentation | | GET | `/health` | No | Health check | ## Project Structure