Giter VIP home page Giter VIP logo

soarca-gui's Introduction

SOARCA-GUI

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.

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.