WebApp to visualize and manage IOT devices written in React, TypeScript, Next.js and Go
HomeBurrow was created by mitrerogelio and linkinlog
- Make edits to .env files first, see # Env variables
- Run
docker compose up
to spin up the backend and frontend in containers - Frontend runs on port 8086
- Backend runs on port 8085
In order to simplify docker and various commands that need to be ran during development we have made some make commands
make server-exec
will runsh
make go GO={XYZ}
will rungo {XYZ}
make get PKG={XYZ}
will rungo get {XYZ}
make tidy
will rungo mod tidy
make test
will rungo test ./...
make client-exec
will runsh
make npm PKG={XYZ}
will runnpm i {XYZ}
make npx PKG={XYZ}
will runnpx {XYZ}
make up
/make down
will rundocker compose up
/docker compose down
make duke_nukem
will down all containers, remove all images/containers/volumes assosciated with homeburrow and then rebuildmake quietbuild
will rebuild with no outputmake rebuild
will rundocker compose down && docker compose up --build
- Run
export QUIET=true
to daemonize docker compose up
- Run
- Currently the .env files live in their respective container folders within docker/
- Duplicate the .env.example files as .env files