Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 2.41 KB

README.md

File metadata and controls

67 lines (40 loc) · 2.41 KB
Raw

SOARCA-GUI

https://cossas-project.org/portfolio/SOARCA/ Pipeline status License

Warning

SOARCA-GUI is still in development and features for the base version v0.1 are still being added.

Warning

Under the hood we make HTMX call-backs to the SOARCA-GUI "backend", here we use polling. Somehow the polling behaviour is flagged by addblockers which block the poll to the backend. Please add an exclusion for the SOARCA-GUI. This issue will be looked at in the future.

A Go, Templ, Tailwind CSS and HTMX based GUI for SOARCA.

Quick Use

Usage of this SOARCA-GUI is described here.

Documentation

All the documentation to off the SOARCA-GUI is currently being worked on.

Contributing

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)

Running this repository

Requirements

Development environment

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 dev

In some cases, the TailwindCSS changes are not picked up correctly. If this happens, you need to rerun:

make build-tailwind
make dev

This will rebuild the required CSS files, and rerun the development environment.