Warning
SOARCA-GUI is still in development and features for the base version v0.1 are still being added.
A Go, Templ, Tailwind CSS and HTMX based GUI for SOARCA.
Usage of this SOARCA-GUI is described here.
All the documentation to off the SOARCA-GUI is currently being worked on.
Want to contribute to this project? Please keep in mind the following rules:
- This repository uses git rebase strategy
- For each PR, there should be at least one issue
- Make sure all tests pass (including lint errors)
- Make
- Go
- Npm
- Templ
The Makefile contains all the required setup for live reloading, meaning that whenever a change is detected in any of the files, the Templ proxy will reload the browser. For file change detection, we use Air. Note that Air does not need to be installed manually, as this is all handled through the Makefile. Although this setup works quite well, it is not perfect.
To start the development environment, run:
make devIn some cases, the TailwindCSS changes are not picked up correctly. If this happens, you need to rerun:
make build-tailwind
make devThis will rebuild the required CSS files, and rerun the development environment.