htmgo/htmgo-site/md/docs/quick-start/installation.md
2024-09-23 12:27:04 -05:00

1.2 KiB

Getting Started

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

tip: GONOPROXY helps because the default proxy server for how go resolves modules appears to have fairly long caching on it, so without this env variable, an old version may get installed.

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


Troubleshooting:

command not found: htmgo ensure you installed htmgo above and ensure GOPATH is set in your shell