Skip to content

Commit

Permalink
chore: add npm run commands to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom Brereton authored and Tom Brereton committed Jan 10, 2024
1 parent 582252c commit ccd284b
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Go Hot Reload is an open-source starter template, designed to streamline the dev

- πŸ”„ **Live Reloading**: Automatic Go rebuild using [`air`](https://github.com/cosmtrek/air). Configured in `.air.toml`.
- πŸ”₯ **Hot Reloading**: Dynamic HTML updates with [`reload`](https://github.com/aarol/reload). Uses `concurrently` npm package for running `air` and `npx tailwind` together. Details in `package.json`.
- πŸ“„ **HTML Templates**: [`chi`](https://github.com/go-chi/chi) router for serving HTML templates.
- πŸ“„ **HTML Templates**: [`chi`](https://github.com/go-chi/chi) router for serving HTML templates.
- πŸ’… **Tailwind**: CSS framework for responsive, customizable UI components with [Tailwind](https://tailwindcss.com/).

## Getting Started
Expand All @@ -33,6 +33,20 @@ The server includes an integration test.
- Execute tests using `go test ./...`.
- Or using npm command `npm run test`

### Commands

Full list of commands for `npm run` are:

```json
"watch:tailwind": "npx tailwindcss -i ./static/css/main.css -o ./static/css/styles.css --watch",
"watch:go": "air",
"dev": "concurrently \"npm run watch:tailwind\" \"npm run watch:go\"",
"test": "go test ./...",
"docker:build": "docker build -f build/Dockerfile -t go-hot-reload .",
"docker:run": "docker run --rm -p 3001:3001 --name go-hot-reload-container go-hot-reload",
"docker:it": "docker run -it --rm go-hot-reload sh"
```

## Contributing to Go Hot Reload

We welcome contributions from the community. Here are some guidelines to help you get started:
Expand Down

0 comments on commit ccd284b

Please sign in to comment.