https://github.com/romshark/demo-islands
An HTMX, Go, Templ, Templier, Shoelace & WebComponents demo demonstrating the islands architecture.
https://github.com/romshark/demo-islands
go golang htmx shoelace templ webcomponents
Last synced: about 1 year ago
JSON representation
An HTMX, Go, Templ, Templier, Shoelace & WebComponents demo demonstrating the islands architecture.
- Host: GitHub
- URL: https://github.com/romshark/demo-islands
- Owner: romshark
- License: mit
- Created: 2024-10-10T20:17:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-04T12:01:52.000Z (about 1 year ago)
- Last Synced: 2025-05-13T03:58:17.363Z (about 1 year ago)
- Topics: go, golang, htmx, shoelace, templ, webcomponents
- Language: Go
- Homepage:
- Size: 7.63 MB
- Stars: 22
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Perfect [Lighthouse](https://developer.chrome.com/docs/lighthouse) score.
[](https://coveralls.io/github/romshark/demo-islands?branch=main)
[](https://goreportcard.com/report/github.com/romshark/demo-islands)
[](https://github.com/romshark/demo-islands?tab=MIT-1-ov-file#readme)
[](https://pkg.go.dev/github.com/romshark/demo-islands)
[](https://github.com/templ-go/awesome-templ)
# Demo: Islands 🏝️
This tech-demo demonstrates a web frontend application written in Go and TypeScript
following the
[Islands of Interactivity](https://www.patterns.dev/vanilla/islands-architecture/)
architectural approach to building highly maintainable modern web applications using
a cutting-edge tech stack:
- **Templating**
- [Templ](https://github.com/a-h/templ) for fast and convenient
server-side templating in Go. 🖨️
- **Dev Tools**
- [Templiér](https://github.com/romshark/templier) for hot-reloads in dev mode. ♻️
- [Bun](https://bun.sh/) for TypeScript bundling and JS package management. 🍞
- [ESLint](https://eslint.org/) for JavaScript/TypeScript linting. 🔎
- **Frontend**
- [TailwindCSS](https://tailwindcss.com/) for easy styling. 💅
- [Shoelace](https://shoelace.style/) for reusable and extensible web components. 👟
- [Lit](https://lit.dev/) for building maintainable and fast web components. 🔥
- **Scripting**
- [Alpine.js](https://alpinejs.dev/) for client-side scripting. ⛰️
- **CI/CD**
- [GitHub Actions](https://github.com/features/actions) for CI/CD.
## Prerequisits
- [Go 1.24](https://go.dev/doc/install)
- [Bun](https://bun.sh/)
- [mkcert](https://github.com/FiloSottile/mkcert) (only when HTTPS is required)
## How To
### Development
Run Témplier to enable automatic hot-reload on source changes:
```sh
./dev.sh
```
Then navigate to http://127.0.0.1:7331.
ℹ️ Use http://127.0.0.1:8080/ to access the actual application server without
the Templiér proxy (this won't auto-reload on changes).
#### HTTPS
If you want to test the server with TLS enabled,
first add the domain to your `/etc/hosts` file:
```
127.0.0.1 islands.demo
```
Then install [mkcert](https://github.com/FiloSottile/mkcert) and run:
```sh
mkcert -install
```
Once the CA certificates are installed, create the certificate and key files:
```sh
mkcert islands.demo
```
Finally, run the server:
```sh
TLS_CERT="islands.demo.pem" TLS_KEY="islands.demo-key.pem" go run ./cmd/server -host islands.demo:8080
```
### Production mode
```sh
# First, build all generated files.
./buildall.sh
# Build server
go build -o server ./cmd/server
# Run server
TLS_CERT="path/to/cert.pem" TLS_KEY="path/to/key.pem" ./server -compress -host hostaddr
```
### Downloading an Icon
This repository uses a subset of
[bootstrap-icons](https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/icons/).
To copy an icon from the CDN and make it available in the public bundle,
use:
```sh
# This will download the person.svg bootstrap icon.
ICON=person bun run download:icon
```