The Remote-GUI is a command-line and web-based interface tool designed to simplify and automate tasks for local development.
This guide will help you set up and run the project on your machine.

• Documentation
• Dockerization
  • Package Docker
  • Run Image
• Prerequisites
• Backend
• Frontend
• Supabase
• Anylog API
• Usage
• Feature Docs

docker build -f Dockerfile . -t anylogco/remote-gui:latest

Volumes used:

• image-vol:/app/CLI/local-cli-backend/static/ – stores images retrieved via query requests
• usr-mgm-vol:/app/CLI/local-cli/backend/usr-mgm/ – stores configurations and management files

Basic Docker Run:

docker run -it -p 8000:8000 -p 3001:3001 --name gui-1 --rm anylogco/remote-gui

Docker Compose:

docker compose -f ./docker-compose.yaml up -d

Before you begin, ensure you have the following installed:

• Node.js (version 14 or higher)
• npm or yarn
• Python 3
• A terminal or command-line interface

1. Inside the Local-CLI directory, cd into local-cli-backend:

   python -m venv .

2. Activate the virtual environment:

   • Windows:

     .\venv\Scripts\activate

   • macOS/Linux:

     source ./venv/bin/activate

3. Install the required packages:

   pip install -r reqs.txt

   Additional useful packages:

   pip install python-dotenv psycopg2 psycopg2-binary

4. Run the backend server:

   fastapi dev main.py
   
   # Run on cloud
   fastapi dev CLI/Local_CLI/local_cli_backend/main.py --host 0.0.0.0 --port 8000

5. The backend server should now be running at:
   👉 http://127.0.0.1:8000

1. Inside the Local-CLI directory, cd into local-cli-fe-full and install dependencies:

   npm install

2. Start the frontend server:

   npm start

   On Ubuntu:

   export NODE_OPTIONS=--openssl-legacy-provider
   npm start

3. Open your browser and go to 👉 http://localhost:3000

(Documentation pending – to be expanded in future versions.)

Follow the instructions from the AnyLog API GitHub Repository.

Run this while the backend venv is activated:

python3 -m pip install $HOME/AnyLog-API/dist/anylog_api-0.0.0-py2.py3-none-any.whl

You can connect to a node in two ways:

• Local node (via Docker Compose): use the IP and port from the container (usually 127.0.0.1:32049).
• Hosted node: use 23.239.12.151:32349.

1. Build:

   docker build -f Dockerfile . -t gui

2. Run (local):

   docker run -it --rm -p 8000:8000 -p 3001:3001      -e REACT_APP_API_URL=http://127.0.0.1:8000      --name gui oshadmon/gui:test

3. Run (production):

   docker run -d      --name gui      -p 8000:8000      -p 3001:3001      -e REACT_APP_API_URL=http://${EXTERNAL_IP}:8000      -e FRONTEND_URL=http://${EXTERNAL_IP}:3001      oshadmon/gui:test

(Coming soon)

(Coming soon)

(Coming soon)

(Coming soon)