Skip to main content
Version: 2.0

Contributing

Development setup​

git clone https://github.com/servasec/servasec.git
cd servasec
make dev

Project structure​

servasec/
├── backend/          # Go backend (Gin + GORM)
│   ├── controllers/  # HTTP handlers
│   ├── models/       # GORM models
│   ├── parsers/      # Scanner output parsers
│   ├── routes/       # Route registration
│   ├── services/     # Business logic
│   ├── middleware/   # Auth, CSRF, rate limit
│   └── pro/          # Pro feature interfaces
├── frontend/         # Next.js web UI
│   └── src/
│       ├── components/  # React components
│       ├── pages/       # Page routes
│       └── lib/         # API client, types
├── caddy/            # Reverse proxy config
└── deploy/           # Podman Quadlet files

Architecture​

Browser → Caddy (TLS) → /api/* → Go/Gin Backend → PostgreSQL
                      → /*    → Next.js Frontend

Key technologies​

  • Backend: Go 1.25, Gin, GORM, Casbin (RBAC), JWT auth
  • Frontend: Next.js 15, TypeScript, shadcn/ui, Tailwind CSS, Recharts
  • Infra: Docker Compose, Caddy 2, PostgreSQL 17

Pull request process​

  1. Create a feature branch from develop
  2. Run make dev and verify your changes
  3. Add or update tests
  4. Submit a PR with a clear description

License​

AGPL-3.0 for community edition. Commercial license for Pro features.