Skip to content

README.md

Latest commit

 

History

History
183 lines (118 loc) · 4.38 KB

README.md

File metadata and controls

183 lines (118 loc) · 4.38 KB

Tari Universe v1

Downloads Platform Support

Desktop Mining Application for Tari

Tari Universe is a desktop application that allows users to mine Tari tokens (XTM) using their Mac or PC. The application features a user-friendly interface with one-click mining setup.

Applications

The Tari Universe ecosystem includes:

  • Tari Universe Desktop App - Mining application for Windows, macOS, and Linux
  • Tari Universe Wallet - Mobile companion app for tracking earnings

Installing using binaries

Download

Download binaries from tari.com. This is the easiest way to run Tari Universe.

Install

After downloading the binaries:

On Windows

Double-click the installer and follow the prompts.

On macOS

Open the .dmg file and drag Tari Universe to your Applications folder.

On Linux

Install the .deb package:

sudo dpkg -i tari-universe_*.deb

Or run the .AppImage:

chmod +x Tari-Universe-*.AppImage
./Tari-Universe-*.AppImage

Run

Launch Tari Universe from your applications menu or desktop shortcut.

Building from source

Install development packages

macOS

brew update
brew install git node cmake protobuf openssl npm

Ubuntu/Debian

sudo apt-get update
sudo apt-get install -y git nodejs npm build-essential \
    libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev \
    patchelf libprotobuf-dev protobuf-compiler libssl-dev \
    pkg-config cmake

Windows

Install Visual Studio Build Tools 2022 with C++ workload, then:

# Install dependencies via chocolatey or vcpkg
choco install git nodejs protoc

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

Install Tauri CLI

cargo install tauri-cli --locked

Build

git clone https://github.com/tari-project/universe.git
cd universe
npm install
npm run tauri build

Output

Built applications will be in target/release/bundle/:

  • Linux: .deb and .AppImage files
  • Windows: .msi installer
  • macOS: .dmg and .app bundle

Contributing

Code Quality

The project uses comprehensive linting tools to maintain code quality:

  • Frontend: ESLint with TypeScript, React, and Prettier integration
  • Backend: Clippy for Rust with custom lint rules

Running Lints

# Frontend linting
npm run lint          # Run all linters (knip + eslint)
npm run lint:fix      # Auto-fix ESLint issues
npm run lint:taplo    # Check TOML file formatting

# Backend linting (from src-tauri directory)
cd src-tauri
cargo clippy          # Run Rust linting
cargo fmt             # Format Rust code

IDE Integration

For the best development experience, install:

  • ESLint extension for automatic JavaScript/TypeScript linting
  • rust-analyzer extension for Rust development
  • Prettier extension for code formatting

Most linting issues can be auto-fixed by your IDE or the lint commands above.

Configuration

Configuration files are stored at:

  • Linux: ~/.config/tari-universe/
  • Windows: %APPDATA%\tari-universe\
  • macOS: ~/Library/Application Support/tari-universe/

Troubleshooting

Application won't start:

  • Check that your system meets minimum requirements
  • Verify firewall isn't blocking the application
  • Try running as administrator (Windows) or with appropriate permissions

Build issues:

  • Ensure all dependencies are installed
  • Check that Rust toolchain is up to date
  • On Windows, use the Visual Studio Developer Command Prompt

Getting Help

Project documentation

License

Tari Universe is open source software licensed under the Enhanced Common Public Attribution License Version 1.0.
⚡