search
Ctrlk

User Requirements & Journeys

hashtag
Set Up For Local Development

hashtag
Prerequisites

System Requirements:

OS: Linux (Ubuntu 18.04+), macOS 10.15+, or Windows 10+ Node.js: Version 18+ with npm

Python: Version 3.8+ for automation scripts Git: Latest version for version control Hardware Requirements:

  1. CPU: 4+ cores recommended for development

  2. RAM: 8GB+ for running multiple services

  3. Storage: 50GB+ free space for dependencies

  4. Network: Stable internet connection Development Tools:

    1. VS Code - Recommended IDE with extensions

    2. Postman - API testing and documentation

    3. SQLite Browser - Database management

    4. Chrome DevTools - Frontend debugging

hashtag
Installation Steps

  1. Clone Repository:

git clone https://github.com/your-org/idle-finance-v2.git cd idle-finance-v2

  1. Install Dependencies: # Frontend dependencies

cd frontend npm install

# Backend dependencies cd ../backend

npm install

# Automation dependencies cd ../automation/golem

pip install -r requirements.txt

  1. Environment Setup:

# Backend environment cd backend

cp .env.example .env

# Edit .env with your configuration

# Frontend environment cd ../frontend

cp .env.example .env

# Edit .env with your configuration

  1. Database Setup: cd backend

npm run migration:run npm run seed

hashtag
Running Locally

  1. Start Backend:

# API available at http://localhost:3000arrow-up-right

# Swagger docs at http://localhost:3000/api/v1/docsarrow-up-right

  1. Start Frontend:

# App available at http://localhost:5173arrow-up-right

  1. Start Automation (Optional): cd automation/golem

python -m uvicorn main:app --reload Automation API at http://localhost:8000arrow-up-right

  1. Build Desktop App: cd frontend

hashtag
How It Works

hashtag
The Curated Wallet System

The Idle Network Curated Wallet System allows users to:

  1. Generate a secure wallet during signup

  2. Encrypt and store keys locally

  3. Automatically collect rewards

  4. Track everything transparently

  5. Keep you in full control

  6. Security:

    1. Everything encrypted locally

    2. Device-specific access

    3. Non-transferable profiles

    4. Automatic backups

hashtag
Behind the Scenes

Your Desktop App:

  1. Cross-platform (Windows, Mac, Linux)

  2. Real-time monitoring

  3. Local sensitive state management

  4. Cloud non-sensitive state management

  5. Automatic updates Our Backend:

    1. Manages your profile and wallet

    2. Orchestrates node deployment

    3. Tracks rewards and performance

    4. Handles all the complex Golem Integration:

      1. Automatically deploys provider nodes

      2. Monitors performance in real-time

      3. Optimizes resource usage

      4. Handles all the technical details Local Reward Tracking:

        1. Tracks GLM earnings locally

        2. Real-time performance monitoring

        3. Secure local storage

        4. Future: Will bridge to other networks

hashtag
Earning Process

How You Earn:

  1. Node runs - Golem provider does compute tasks

  2. Rewards earned - GLM tokens on Ethereum network

  3. Automatic tracking - we monitor everything locally

  4. Real-time updates - see earnings as they happen

  5. Future features - bridging and vaults coming soon

hashtag
Using Idle Network

hashtag
Dashboard

Your main control center shows:

  1. Connection status - animated rings show if you're connected

  2. Earnings - live GLM token tracking

  3. System health - CPU, memory, disk usage

  4. Node controls - start/stop your node

  5. Performance - uptime and efficiency stats

Everything updates in real-time. No manual refresh needed.

hashtag
Rewards

  1. Live updates - see GLM tokens as they come in

  2. History - earnings over time

  3. Collection - rewards automatically tracked

  4. Transparency - know exactly what you're earning

hashtag
Node Management

  1. Start/Stop - one-click control

  2. Status - see if it's running

  3. Resources - CPU, memory, disk usage

  4. Performance - uptime and efficiency

  5. Settings - we optimize automatically

hashtag
Activity Log

See everything that happens:

  1. Node events - starts, stops, status changes

  2. Rewards - when you earn GLM tokens

  3. System alerts - performance issues

  4. Performance - uptime and resource usage

hashtag
Settings

Manage your account:

  1. Profile - name, email, device info

  2. Wallet - view your curated wallet (show/hide address)

  3. Preferences - notifications, optimizations

Security - two-factor auth, account protection

See everything that happens:

  1. Node events - starts, stops, status changes

  2. Rewards - when you earn GLM tokens

  3. System alerts - performance issues

  4. Performance - uptime and resource usage

Last updated