https://github.com/crhntr/muxt-template-module-no-tools-file

https://github.com/crhntr/muxt-template-module-no-tools-file

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/crhntr/muxt-template-module-no-tools-file
• Owner: crhntr
• License: unlicense
• Created: 2024-10-31T09:41:22.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-31T09:43:46.000Z (about 2 months ago)
• Last Synced: 2024-10-31T10:27:30.012Z (about 2 months ago)
• Language: Go
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A Simple MUXT Project Template using HTMX

This is an example [muxt](http://github.com/crhntr/muxt) hypertext server.

See this article for how to use this template: https://go.dev/blog/gonew.

It is based on https://github.com/crhntr/muxt-template-module-htmx.

You may also want to see:

- [HTMX](https://htmx.org): configured for site interactivity

- [Pico CSS](https://picocss.com/docs): configured to make the site look a bit better by default

- [counterfeiter](https://github.com/maxbrunsfeld/counterfeiter): used to generate fake Server implementations for testing templates

- [unpkg.com](https://unpkg.com): use the meta query param to get new version integrity values

It extends the module by using sqlc to for database interactions with PostgreSQL.

- [sqlc](https://docs.sqlc.dev/en/latest/): to generate type safe database interactions

- [pqx](https://pkg.go.dev/github.com/jackc/pgx/v5): for a database driver

- [goose](https://github.com/pressly/goose): for migrations

## Developing

Add new html in `./internal/hypertext/templates`.

Use inline template declarations in the template files using muxt template name semantics

then run Go generate to generate a function that maps hypertext concepts to helpful handler methods.

## Testing

After developing routes, run `go generate ./...`.

Write handler tests in `./internal/hypertext/server_test.go`.

Write template tests in `./internal/hypertext/template_routes_test.go`.

Run tests with: `go test ./...`

## Database

Set the database URL with the environment variable `DATABASE_URL`.