initial
This commit is contained in:
242
README.md
Normal file
242
README.md
Normal file
@@ -0,0 +1,242 @@
|
||||
# Go + HTMX Template
|
||||
|
||||
This is a template repository that comes with everything you need to build a Web Application using Go (templ) and HTMX.
|
||||
|
||||
The template comes with a basic structure of using a SQL DB (`sqlc`), E2E testing (playwright), and styling (tailwindcss).
|
||||
|
||||
## Getting Started
|
||||
|
||||
In the top right, select the dropdown __Use this template__ and select __Create a new repository__.
|
||||
|
||||
Once cloned, run the `update_module.sh` script to change the module to your module name.
|
||||
|
||||
```shell
|
||||
./update_module vctpule
|
||||
```
|
||||
|
||||
## Technologies
|
||||
|
||||
A few different technologies are configured to help getting off the ground easier.
|
||||
|
||||
- [sqlc](https://sqlc.dev/) for database layer
|
||||
- Stubbed to use SQLite
|
||||
- This can be easily swapped with [sqlx](https://jmoiron.github.io/sqlx/)
|
||||
- The script `upgrade_sqlc.sh` is available to upgrade GitHub Workflow files to latest sqlc version
|
||||
- [Tailwind CSS](https://tailwindcss.com/) for styling
|
||||
- Output is generated with the [CLI](https://tailwindcss.com/docs/installation)
|
||||
- [templ](https://templ.guide/) for creating HTML
|
||||
- The script `upgrade_templ.sh` is available to make upgrading easier
|
||||
- [HTMX](https://htmx.org/) for HTML interaction
|
||||
- The script `upgrade_htmx.sh` is available to make upgrading easier
|
||||
- [air](https://github.com/cosmtrek/air) for live reloading of the application.
|
||||
- [golang migrate](https://github.com/golang-migrate/migrate) for DB migrations.
|
||||
- [playwright-go](https://github.com/playwright-community/playwright-go) for E2E testing.
|
||||
|
||||
Everything else uses the standard library.
|
||||
|
||||
## Structure
|
||||
|
||||
```text
|
||||
.
|
||||
├── Makefile
|
||||
├── components
|
||||
│ ├── core
|
||||
│ │ └── html.templ
|
||||
│ └── home
|
||||
│ └── home.templ
|
||||
├── db
|
||||
│ ├── db.go
|
||||
│ ├── local.go
|
||||
│ ├── migrations
|
||||
│ │ ├── 20240407203525_init.down.sql
|
||||
│ │ └── 20240407203525_init.up.sql
|
||||
│ └── queries
|
||||
│ └── query.sql
|
||||
├── db.sqlite3
|
||||
├── dist
|
||||
│ ├── assets
|
||||
│ │ └── js
|
||||
│ │ └── htmx@1.9.10.min.js
|
||||
│ └── dist.go
|
||||
├── e2e
|
||||
│ ├── e2e_test.go
|
||||
│ ├── home_test.go
|
||||
│ └── testdata
|
||||
│ └── seed.sql
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── log
|
||||
│ └── log.go
|
||||
├── main.go
|
||||
├── server
|
||||
│ ├── handler
|
||||
│ │ ├── handler.go
|
||||
│ │ └── home.go
|
||||
│ ├── middleware
|
||||
│ │ ├── cache.go
|
||||
│ │ ├── logging.go
|
||||
│ │ └── middleware.go
|
||||
│ ├── router
|
||||
│ │ └── router.go
|
||||
│ └── server.go
|
||||
├── sqlc.yml
|
||||
├── styles
|
||||
│ └── input.css
|
||||
├── tailwind.config.js
|
||||
└── version
|
||||
└── version.go
|
||||
```
|
||||
|
||||
### Components
|
||||
|
||||
This is where `templ` files live. Anything you want to render to the user goes here. Note, all
|
||||
`*.go` files will be ignored by `git` (configured in `.gitignore`).
|
||||
|
||||
### DB
|
||||
|
||||
This is the directory that `sqlc` generates to. Update `queries.sql` to build
|
||||
your database operations.
|
||||
|
||||
This project uses [golang migrate](https://github.com/golang-migrate/migrate) for DB
|
||||
migrations. `sqlc` uses the `db/migrations` directory to generating DB tables. Call
|
||||
`db.Migrate(..)` to automatically migrate your database to the latest version. To add migration
|
||||
call the following command,
|
||||
|
||||
```shell
|
||||
migrate create -ext sql -dir db/migrations <name of migration>
|
||||
```
|
||||
|
||||
This package can be easily update to use `sqlx` as well.
|
||||
|
||||
### Dist
|
||||
|
||||
This is where your assets live. Any Javascript, images, or styling needs to go in the
|
||||
`dist/assets` directory. The directory will be embedded into the application.
|
||||
|
||||
Note, the `dist/assets/css` will be ignored by `git` (configured in `.gitignore`) since the
|
||||
files that are written to this directory are done by the Tailwind CSS CLI. Custom styles should
|
||||
go in the `styles/input.css` file.
|
||||
|
||||
### E2E
|
||||
|
||||
To test the UI, the `e2e` directory contains the Go tests for performing End to end testing. To
|
||||
run the tests, run the command
|
||||
|
||||
```shell
|
||||
go test -v ./... -tags=e2e
|
||||
```
|
||||
|
||||
The end to end tests, will start up the app, on a random port, seeding the database using the
|
||||
`seed.sql` file. Once the tests are complete, the app will be stopped.
|
||||
|
||||
The E2E tests use Playwright (Go) for better integration into the Go tooling.
|
||||
|
||||
### Log
|
||||
|
||||
This contains helper function to create a `slog.Logger`. Log level and output type can be set
|
||||
with then environment variables `LOG_LEVEL` and `LOG_OUTPUT`. The logger will write to
|
||||
`stdout`.
|
||||
|
||||
### Server
|
||||
|
||||
This contains everything related to the HTTP server. It comes with a graceful shutdown handler
|
||||
that handles `SIGINT`.
|
||||
|
||||
#### Router
|
||||
|
||||
This package sets up the routing for the application, such as the `/assets/` path and `/` path.
|
||||
It uses the standard libraries mux for routing. You can easily swap out for other HTTP
|
||||
routers such as [gorilla/mux](https://github.com/gorilla/mux).
|
||||
|
||||
#### Middleware
|
||||
|
||||
This package contains any middleware to configured with routes.
|
||||
|
||||
#### Handler
|
||||
|
||||
This package contains the handler to handle the actual routes.
|
||||
|
||||
#### Styles
|
||||
|
||||
This contains the `input.css` that the Tailwind CSS CLI uses to generate your output CSS.
|
||||
Update `input.css` with any custom CSS you need and it will be included in the output CSS.
|
||||
|
||||
#### Version
|
||||
|
||||
This package allows you to set a version at build time. If not set, the version defaults to
|
||||
`dev`. To set the version run the following command,
|
||||
|
||||
```shell
|
||||
go build -o ./app -ldflags="-X version.Value=1.0.0"
|
||||
```
|
||||
|
||||
See the `Makefile` for building the application.
|
||||
|
||||
## Run
|
||||
|
||||
There are a couple builtin ways to run the application - using `air` or the `Makefile` helper
|
||||
commands.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Install [templ](https://templ.guide/quick-start/installation)
|
||||
- Install [sqlc](https://docs.sqlc.dev/en/stable/overview/install.html)
|
||||
- Install [tailwindcss CLI](https://tailwindcss.com/docs/installation)
|
||||
- Install [air](https://github.com/cosmtrek/air#installation)
|
||||
|
||||
### air
|
||||
|
||||
`air` has been configured with the file `.air.toml` to allow live reloading of the application
|
||||
when a file changes.
|
||||
|
||||
To run, install `air`
|
||||
|
||||
```shell
|
||||
go install github.com/cosmtrek/air@latest
|
||||
```
|
||||
|
||||
Then simply run the command
|
||||
|
||||
```shell
|
||||
air
|
||||
```
|
||||
|
||||
#### Address Already In Use Error
|
||||
|
||||
Sometimes, you may run into the issue _address already in use_. If this is the case, you
|
||||
can run this command to find the PID to kill it.
|
||||
|
||||
```shell
|
||||
ps aux | grep tmp/main
|
||||
```
|
||||
|
||||
### Makefile
|
||||
|
||||
You can also run with the provided `Makefile`. There are commands to generate `templ` files and
|
||||
tailwind output css.
|
||||
|
||||
```shell
|
||||
# Generate and watch templ
|
||||
make generate-templ-watch
|
||||
|
||||
# Genrate and watch tailwindcss
|
||||
make generate-tailwind-watch
|
||||
|
||||
# Run application
|
||||
make run
|
||||
```
|
||||
|
||||
## Github Workflow
|
||||
|
||||
The repository comes with two Github workflows as well. One called `ci.yml` that lints and
|
||||
tests your code. The other called `release.yml` that creates a tag, GitHub Release, and
|
||||
attaches the Linux binary to the Release.
|
||||
|
||||
Note, the version of `github.com/a-h/templ/cmd/templ` matches the version in `go.mod`. If these
|
||||
do not match, the build will fail. When upgrading your `templ` version, make sure to update
|
||||
`ci.yml` and `release.yml`.
|
||||
|
||||
### GoReleaser
|
||||
|
||||
If you need to compile for more than Linux, see [GoReleaser](https://goreleaser.com/) for a
|
||||
better release process.
|
||||
Reference in New Issue
Block a user