GoTH Stack

Getting started

Setup script

Inside the root directory is a `setup.sh`` script that will create a public/private key pair, add them to a .env file and the module with your module name.

Make the script executable

chmod +x setup.sh

Run the script

./setup.sh

Manual setup

1. Clone the repo
2. Run go mod tidy
3. Create a .env file for local development with a base64 encoded JWT_PRIVATE_KEY and a base64 encoded JWT_PUBLIC_KEY
4. Find and replace github.com/tomdoestech/goth with your own module name
5. Download Air - https://github.com/cosmtrek/air

Running the server

make dev

Running the tests

make test

The JWT_PRIVATE_KEY and JWT_PUBLIC_KEY are base64 encoded to eliminate issues with formatting the keys. You can use keys that aren't base64 encoded by updating internal/config/config.go and removing the decode functionality.

Contributing

Contributions are welcome. Please open an issue to discuss your idea before opening a PR unless it's a fix for a bug or a typo.

Principles

1. Simplicity
2. Speed
3. Interactivity
4. Security

Included features

The included features are minimal because this is just a starting point. If you think there is a feature missing that all projects need, please open an issue.

1. Register an account with email and password
2. Login with email and password
3. Logout

Templates

The templates are written in Go Templates. The templates are located in the templates directory. The templates/base template is the base template that all other templates extend. The templates/partial directory contains partial templates that are included in other templates.

Styles

The tailwindcss executable is for linux x64. If your system requires a different executable, please following this guide: https://tailwindcss.com/blog/standalone-cli

Basically all you need to do is download the executable from here, mode it so it's runnable and then optionally rename it to tailwindcss.

Generate a new style.css file and watch for changes:

./tailwindcss -i static/css/input.css -o static/css/style.css --watch

Generate a new minified style.css file for production:

./tailwindcss -i static/css/input.css -o static/css/style.css --minify

Security

The header partial templates/partial/header includes a meta tag with the CSP headers. The included shad256 hash is because HTMX will create an inline style tag, so this hash is for that tag.

Please also read the HTMX security guide.

Metrics

By default there is a metrics server that starts at http://localhost:9100/metrics and serves prometheus metrics.