Skip to content

Commit

Permalink
docs: update hot reload development server docs
Browse files Browse the repository at this point in the history
  • Loading branch information
peterxcli committed Jan 19, 2024
1 parent 42d26ca commit 04b54af
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .air.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Config file for [Air](https://github.com/cosmtrek/air) in TOML format

# Working directory
# . or absolute path, please note that the directories following must be under root
root = "."
tmp_dir = "tmp_app"

[build]
# Just plain old shell command. You could use `make` as well.
cmd = "go build -o ./tmp_app/app/engine ./cmd/main.go"
# Binary file yields from `cmd`.
bin = "tmp_app/app"
# Customize binary.
full_bin = "./tmp_app/app/engine"
# This log file places in your tmp_dir.
log = "air_errors.log"
# Watch these filename extensions.
include_ext = ["go", "yaml", "toml", ".env.*"]
# Ignore these filename extensions or directories.
exclude_dir = ["tmp_app", "tmp", "docker", "Caddyfile"]
# It's not necessary to trigger build each time file changes if it's too frequent.
delay = 1000 # ms

[log]
# Show log time
time = true

[color]
# Customize each part's color. If no color found, use the raw app log.
main = "magenta"
watcher = "cyan"
build = "yellow"
runner = "green"

[misc]
# Delete tmp directory on exit
clean_on_exit = true
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,6 @@
4. Run `make dev-up` to start the development database and redis
[//]: # (5. Run `make dev-migrate` to migrate the database)
5. Run `make run` to start the development server with **no** live reload
> Run `make serve` to start the development server with live reload(but requires `air` to be installed)
1. Webserver will be listening on [localhost:8000](http://localhost:8000), you may change the port in `.env.dev`
6. Run `make dev-down` to stop the development database and redis

0 comments on commit 04b54af

Please sign in to comment.