htmgo/htmgo-site/md/docs/1_quick-start/2_installation.md
2024-09-26 15:41:57 -05:00

1.2 KiB

Getting Started

Prerequisites:
  1. Go: https://go.dev/doc/install
  2. Familiarity with https://htmx.org and html/hypermedia
    1. If you have not read the htmx docs, please do so before continuting, a lot of concepts below will be much more clear after.

1. Install htmgo
GOPROXY=direct go install github.com/maddalax/htmgo/cli/htmgo@latest

2. Create new project Once htmgo cli tool is installed, run

htmgo template

this will ask you for a new app name, and it will clone our starter template to a new directory it creates with your app name.


3. Running the dev server htmgo has built in live reload on the dev server, to use this, run this command in the root of your project

htmgo watch

If you prefer to restart the dev server yourself (no live reload), use

htmgo run
4. Core concepts

View the core concepts of how to use htmgo, such as adding pages, using partials, routing, etc.


5. Building for production htmgo cli can be used to build the application for production as a single binary

htmgo build

it will be output to ./dist