UpSnap/README.md

UpSnap v3

This is the dev branch for v3. It's very much in progress but will have a release candidate once all boxes below are checked.

Help developing

Fork this branch and clone it.

1. Start backend

cd backend
go mod tidy
go run main.go serve

Log in to http://127.0.0.1:8090/_/, create an admin user and add some devices.

2. Start frontend

cd frontend
pnpm i
pnpm run dev

Open up localhost:5173/

To do

• frontend

  • add rest of settings page
  • form for adding new devices
  • add per device settings
  • theme toggle button
  • add device ports to cards

• backend

  • make sure ping works
  • make sure arp works
  • make sure wake works
  • remove nmap?
  • #34 Add support for WOL passwords
  • #33 Seemingly High Ram usage
  • #32 API available?

• add db import from v2

• move docker images to github packages and setup new workflow file

• create dockerfile and docker-compose.yml