HolyCluster

An ongoing effort to visualize the ham radio cluster

Prerequisites ⚙️

• A computer running Linux, macOS, or Windows
• git
• python3
• node, npm

Installation 🛠

1. Clone the repository and enter its directory

   git clone https://github.com/4Z1KD/HolyCluster
   cd HolyCluster

2. Create a virtual environment (https://docs.python.org/3/library/venv.html)

   python -m venv venv_HolyCluster

3. Activate the virtual environment
   • Windows: \venv_HolyCluster\Scripts\activate.bat
   • Linux and macOS: source venv_HolyCluster/bin/activate
4. Install the project (-e is for development mode)

   pip install -e .

5. Build the frontend

   cd ui
   npm install
   npm run build

To deactivate the virtual environment, run deactivate.

Usage 💾

For now, the recommended way to run the application is by starting the client side server. Run this in the project's root directory:

uvicorn --reload ClientSideServer:app

For systems without omnirig installed, execute

DUMMY=1 uvicorn --reload ClientSideServer:app

Then visit the main page at http://localhost:8000/index.html.

In the future, the application will be compiled into an executable 💾

Progress 📈

Since this project is a work in progress, you may experience poor performance, bugs, runtime issues, and maybe more. We are working on fixing these issues.