superkit/README.md

GOTHKIT

Create interactive applications with Golang, HTMX, and Templ

Table of content

• GOTHKIT
  • Table of content
• Installation
• Getting started
  • Application structure
    • assets
    • conf
    • db
    • events
    • handlers
    • types
    • views
  • Development server
  • Hot reloading the browser
• Migrations
  • Create a new migration
  • Migrate the database
  • Reset the database
  • Seeds
• Testing
  • Testing handlers
• Create a production release

Installation

go install github.com/anthdm/gothkit@master

After installation you can create a new project by running:

gothkit [myprojectname]

You can now navigate to your project:

cd [myprojectname]

Getting started

Application structure

assets

conf

db

events

handlers

types

views

Development server

Run the development server with the following command:

make dev 

Hot reloading the browser

Hot reloading is configured by default when running your application in development.

NOTE: on windows you might need to run make assets in another terminal for god knows why.

Migrations

Create a new migration

make db-mig add_user_table

Will create a new migration SQL file inside app/db/migrations

Migrate the database

make db-up

Reset the database

make db-reset

Seeds

make db-seed

This command will run the seeds file located at cmd/scripts/seed/main.go

Testing

Testing handlers

Create a production release

Gothkit will compile your whole application including its assets into a single binary. To build your application for production you can run the following command:

make build

This will create a binary file located at /bin/app_release.

Make sure you also set the correct application environment variable in your .env file.

APP_ENV	= production