kubokit

A REST API starter kit with straightforward approach and minimal dependencies.

Requirements

• Go 1.24 or higher
• docker or podman

Quick Start

1. Create a repository from the template.

gh repo create my-rest-api --template ferdiebergado/kubokit --public --clone

2. Rename .env.example to .env and update the values based on your environment.

mv .env.example .env

3. Generate an app key.

make app-key

4. Run the api in development mode.

make dev

5. Send requests to the api at localhost:8888.

curl -X POST -H 'Content-Type: application/json' -d '{"email": "abc@example.com", "password": "test"}' localhost:8888/auth/login

Running Tests

Create a .env.testing file by copying .env.

cp .env .env.testing

Update the values according to your testing environment.

Unit Tests

To run unit tests, run the following command:

make test ENV=testing

Integration Tests

To run integration tests, run the following command:

make test-integration ENV=testing

Tasks

Common development tasks are captured in the Makefile. To view those tasks, run the following command:

make

If a required tool is missing, it will be automatically installed.