2024-09-20 17:18:22 +00:00
|
|
|
## **Getting Started**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
##### 1. **Install htmgo**
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
go install github.com/maddalax/htmgo/cli/htmgo@latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**2. Create new project**
|
|
|
|
|
Once htmgo cli tool is installed, run
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
htmgo watch
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
If you prefer to restart the dev server yourself (no live reload), use
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
htmgo run
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
##### **4. Core concepts**
|
|
|
|
|
|
|
|
|
|
View the [core concepts](/docs#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
|
2024-09-20 16:45:23 +00:00
|
|
|
|
|
|
|
|
```bash
|
2024-09-20 17:18:22 +00:00
|
|
|
htmgo build
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
it will be output to **./dist**
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br>
|
|
|
|
|
|
|
|
|
|
## **Troubleshooting:**
|
|
|
|
|
|
|
|
|
|
**command not found: htmgo**
|
|
|
|
|
ensure you installed htmgo above and ensure GOPATH is set in your shell
|
