developer.md

QATARINA Developer Docs

Setup Taskfile (Optional)

You can set up Taskfile to simplify the dev process (or you can run all commands manually)

go install github.com/go-task/task/v3/cmd/task@latest

You can find most of the commands you need for this project in Taskfile.yml

Using sqlc for database queries

We use SQLC in the project for generating Go code from SQL for the database layer. In order to add queries for the database layer, you will need to modify the query.sql file which stores all the queries and author an SQLC compatible query. Read on how to write queries here

After modifying the query.sql file, you will need to run the following command to generate the Go code for that. This will generate code in the internal/database/dbsqlc directory

$ sqlc generate

Generally, we recommend using the generated code from a Repository or Service type rather than using the queries in API handlers and other places directly.

Components

The system is designed to be deployed as a single binary, but has subcommands that launch different components or run commands.

# Runs the database migrations
$ qatarina migrate

# Runs the server
$ qatarina server

Create new user

To create a new user after initializing for the first time you can run

qatarina user new --name="root root" --password=root --email=root@mail.com

Building the Front-end

Use the following instructions to build the frontend for embedding into the final binary built with Go.

$ cd ui

$ npm run build