Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.43 KB

README.md

File metadata and controls

81 lines (56 loc) · 2.43 KB
Raw

Go :: TempL :: HTMX :: Tailwind :: Bun -- Starter Kit

🚀 Features

✨ How to use

Prerequisites

Install Taskfile and Air

run bun install

Generating Code

The server binary embeds the static file directory and serves anything contained within under src/static. To build the server binary you should first generate the tailwind, templ, and any other necessary generated code for your app:

task generate

Building the binary:

Once all files have been generated, the binary can be built just like any other go binary:

go build -o build/server .src/main.go

Or you can use the build task which will generate code before building the binary:

task build

Containerized Builds

You can easily containerize the build using the provided Dockerfile. Make sure all code is generated before triggering a build of the container, or use the container task which will generate any code first:

task container container_name=my-app container_tag=test

Railway

Deploying to Railway doesn't require any special configuration. You can just fork this repository and configure Railway to use your forked repository. Railway will then automatically build and deploy your main branch on every change.

Note: This template was designed to deploy to Railway in mind but there is nothing prohibiting this template from working elsewhere. The binary is just a standard go http server. The Dockerfile should work just about anywhere the runs containers.

Development Mode

Development mode will watch for changes in the source code and restart the server automatically. It will also watch for changes in the static files and recompile them automatically.

task dev

📦 Structure

src/
├── static/
│   └── (static files served directly at /static/*)
├── templates/
│   └── (reusable Templ components)
└── views/
    └── (views and routes for views)