Nekomata API (nkm-api)

🚀 Requirements

• Go 1.24
• PostgreSQL 17
• Dragonfly
• Air — for hot reloading

---

⚡ Quick Start

1. Install all requirements

2. Copy config.example.yml to config.yml and update the config

3. Install dependencies:

   go mod tidy
   

4. Start the server:

   go run ./cmd/gen
   go run ./cmd/server
   # or with hot reload
   air
   

---

📚 API Docs

Interactive API documentation will be available at:

• http://<base-address>/api/v1/docs

OpenAPI specification will be available at:

• http://<base-address>/api/v1/openapi.json
• http://<base-address>/api/v1/openapi.yaml

---

🔐 Permission Management

Permission Calculator

The project includes a command-line tool to help calculate permission values for user roles:

go run ./cmd/permissions

This interactive tool allows you to:

• Select and deselect individual permissions
• View the final uint64 permission value
• See binary and hexadecimal representations
• Get a human-readable list of selected permissions

---