{"id":17698451,"url":"https://github.com/romshark/demo-islands","last_synced_at":"2025-05-13T03:58:24.851Z","repository":{"id":258034185,"uuid":"870870287","full_name":"romshark/demo-islands","owner":"romshark","description":"An HTMX, Go, Templ, Templier, Shoelace \u0026 WebComponents demo demonstrating the islands architecture.","archived":false,"fork":false,"pushed_at":"2025-05-04T12:01:52.000Z","size":7999,"stargazers_count":22,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-13T03:58:17.363Z","etag":null,"topics":["go","golang","htmx","shoelace","templ","webcomponents"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/romshark.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-10T20:17:44.000Z","updated_at":"2025-05-09T18:12:58.000Z","dependencies_parsed_at":"2024-10-25T02:03:14.447Z","dependency_job_id":"701fa987-ca4e-4cd2-b86d-591245f5b3f2","html_url":"https://github.com/romshark/demo-islands","commit_stats":null,"previous_names":["romshark/demo-islands"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romshark%2Fdemo-islands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romshark%2Fdemo-islands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romshark%2Fdemo-islands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romshark%2Fdemo-islands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romshark","download_url":"https://codeload.github.com/romshark/demo-islands/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253870858,"owners_count":21976612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go","golang","htmx","shoelace","templ","webcomponents"],"created_at":"2024-10-24T15:08:36.838Z","updated_at":"2025-05-13T03:58:24.839Z","avatar_url":"https://github.com/romshark.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![lighthouse_desktop_score](https://github.com/user-attachments/assets/5ccea4f9-8040-4a09-8d78-8a235f3715d8)\n\nPerfect [Lighthouse](https://developer.chrome.com/docs/lighthouse) score.\n\n[![Coverage Status](https://coveralls.io/repos/github/romshark/demo-islands/badge.svg?branch=main)](https://coveralls.io/github/romshark/demo-islands?branch=main)\n[![GoReportCard](https://goreportcard.com/badge/github.com/romshark/demo-islands)](https://goreportcard.com/report/github.com/romshark/demo-islands)\n[![License](https://img.shields.io/github/license/romshark/demo-islands)](https://github.com/romshark/demo-islands?tab=MIT-1-ov-file#readme)\n[![GoDoc](https://godoc.org/github.com/romshark/demo-islands?status.svg)](https://pkg.go.dev/github.com/romshark/demo-islands)\n[![Awesome](https://awesome.re/badge.svg)](https://github.com/templ-go/awesome-templ)\n\n# Demo: Islands 🏝️\n\nThis tech-demo demonstrates a web frontend application written in Go and TypeScript\nfollowing the\n[Islands of Interactivity](https://www.patterns.dev/vanilla/islands-architecture/)\narchitectural approach to building highly maintainable modern web applications using\na cutting-edge tech stack:\n\n- **Templating**\n  - [Templ](https://github.com/a-h/templ) for fast and convenient\n    server-side templating in Go. 🖨️\n- **Dev Tools**\n  - [Templiér](https://github.com/romshark/templier) for hot-reloads in dev mode. ♻️\n  - [Bun](https://bun.sh/) for TypeScript bundling and JS package management. 🍞\n  - [ESLint](https://eslint.org/) for JavaScript/TypeScript linting. 🔎\n- **Frontend**\n  - [TailwindCSS](https://tailwindcss.com/) for easy styling. 💅\n  - [Shoelace](https://shoelace.style/) for reusable and extensible web components. 👟\n  - [Lit](https://lit.dev/) for building maintainable and fast web components. 🔥\n- **Scripting**\n  - [Alpine.js](https://alpinejs.dev/) for client-side scripting. ⛰️\n- **CI/CD**\n  - [GitHub Actions](https://github.com/features/actions) for CI/CD.\n\n## Prerequisits\n\n- [Go 1.24](https://go.dev/doc/install)\n- [Bun](https://bun.sh/)\n- [mkcert](https://github.com/FiloSottile/mkcert) (only when HTTPS is required)\n\n## How To\n\n### Development\n\nRun Témplier to enable automatic hot-reload on source changes:\n\n```sh\n./dev.sh\n```\n\nThen navigate to http://127.0.0.1:7331.\n\nℹ️ Use http://127.0.0.1:8080/ to access the actual application server without\nthe Templiér proxy (this won't auto-reload on changes).\n\n#### HTTPS\n\nIf you want to test the server with TLS enabled,\nfirst add the domain to your `/etc/hosts` file:\n\n```\n127.0.0.1 islands.demo\n```\n\nThen install [mkcert](https://github.com/FiloSottile/mkcert) and run:\n\n```sh\nmkcert -install\n```\n\nOnce the CA certificates are installed, create the certificate and key files:\n\n```sh\nmkcert islands.demo\n```\n\nFinally, run the server:\n\n```sh\nTLS_CERT=\"islands.demo.pem\" TLS_KEY=\"islands.demo-key.pem\" go run ./cmd/server -host islands.demo:8080\n```\n\n### Production mode\n\n```sh\n# First, build all generated files.\n./buildall.sh\n\n# Build server\ngo build -o server ./cmd/server\n\n# Run server\nTLS_CERT=\"path/to/cert.pem\" TLS_KEY=\"path/to/key.pem\" ./server -compress -host hostaddr\n```\n\n### Downloading an Icon\n\nThis repository uses a subset of\n[bootstrap-icons](https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/icons/).\nTo copy an icon from the CDN and make it available in the public bundle,\nuse:\n\n```sh\n# This will download the person.svg bootstrap icon.\nICON=person bun run download:icon\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromshark%2Fdemo-islands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromshark%2Fdemo-islands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromshark%2Fdemo-islands/lists"}