Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md, re-order potentially confusing build steps #96

Merged
merged 1 commit into from
Nov 12, 2024
Merged

Update README.md, re-order potentially confusing build steps #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Image is just `nwesterhausen/domain-monitor`, latest tag will be the most recent

### Running Locally

Should by OS agnostic. Requires go and nodejs. Clone this repo and follow the [build instructions](#development). Then you can run the binary alongside the `assets` folder.
Should be OS-agnostic. Requires Go and NodeJS. Clone this repo and follow the [build instructions](#development). Then you can run the binary alongside the `assets` folder.

Configuration can be done via the configuration page of the web gui
(default http://localhost:3124)
Expand Down Expand Up @@ -235,19 +235,11 @@ Requirements:
- [golang](https://golang.org/)
- [nodejs](https://nodejs.org/)
- [pnpm](https://pnpm.io/)
- [air](https://github.com/cosmtrek/air) `go install github.com/cosmtrek/air@latest`
- [air](https://github.com/air-verse/air) `go install github.com/air-verse/air@latest`
- [templ](https://github.com/a-h/templ/) `go install github.com/a-h/templ/cmd/templ@latest`

### Development server

To run the development server, use the following command:

```sh
air
```

Air will take care of all the build steps whenever a change is detected.

Build steps:

1. Install npm dependencies and "build" (copy the JS libraries to the `assets` folder).
Expand All @@ -269,3 +261,11 @@ go build cmd/main.go
```

The binary requires the `assets` folder to be in the same directory as the binary.

To run the development server, use the following command:

```sh
air
```

Air will take care of all the build steps whenever a change is detected.
Loading