generated from maragudk/template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f6cd394
commit caebd38
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,41 @@ A starter kit for building a web app with gomponents, HTMX, and TailwindCSS in G | |
Made with ✨sparkles✨ by [maragu](https://www.maragu.dev/). | ||
|
||
Does your company depend on this project? [Contact me at [email protected]](mailto:[email protected]?Subject=Supporting%20your%20project) to discuss options for a one-time or recurring invoice to ensure its continued thriving. | ||
|
||
## Getting started | ||
|
||
The easiest way to get started is to [Use this template](https://github.com/new?template_name=gomponents-starter-kit&template_owner=maragudk) to create a new repository. Or you could clone this repository the traditional way: | ||
|
||
```shell | ||
git clone [email protected]:maragudk/gomponents-starter-kit.git your-app-name | ||
``` | ||
|
||
After that, you can start the app with: | ||
|
||
```shell | ||
make start | ||
``` | ||
|
||
If you make style changes, watch the CSS with: | ||
|
||
```shell | ||
make watch-css | ||
``` | ||
|
||
You can run tests and linting with: | ||
|
||
```shell | ||
make test lint | ||
``` | ||
|
||
## Deploying | ||
|
||
The [CD workflow](.github/workflows/cd.yml) automatically builds a multi-platform Docker image and pushes it to the Github container registry GHCR.io, tagged with the commit hash as well as `latest`. | ||
|
||
You can try building the image locally with: | ||
|
||
```shell | ||
make build-docker | ||
``` | ||
|
||
Note that [you need the containerd image store enabled](https://docs.docker.com/desktop/containerd/#enable-the-containerd-image-store) for this to work. |