124 lines
3.8 KiB
Markdown
124 lines
3.8 KiB
Markdown
# Ziya - Slint Edition
|
||
|
||
**One stop shop for your trading habit** - Now powered by Slint and Rust!
|
||
|
||
> **/dˤiˈjaːʔ/**, "zee‑yah" — *Proper noun, meaning "light"*
|
||
> A bismillahDAO creation
|
||
|
||
## Overview
|
||
|
||
Ziya is a modern, high-performance trading platform built with [Slint](https://slint.dev/) and Rust. Designed for cryptocurrency traders who demand speed, reliability, and a beautiful user interface.
|
||
|
||
## Features
|
||
|
||
- **⚡ Lightning Fast**: Native Rust performance with instant startup
|
||
- **🎨 Beautiful UI**: Modern interface built with Slint's declarative language
|
||
- **📊 Real-time Data**: Live token prices and market analysis
|
||
- **🔒 Secure**: Type-safe Rust backend with robust error handling
|
||
- **📱 Native Feel**: True desktop application, not a web wrapper
|
||
- **🚀 Lightweight**: ~5MB standalone binary vs ~100MB Electron apps
|
||
|
||
## Installation
|
||
|
||
### Download Pre-built Binaries
|
||
|
||
Visit our [Releases](https://github.com/rizilab/ziya/releases) page to download the latest version for your platform:
|
||
|
||
- **Windows**: `ziya-x86_64-pc-windows-msvc.zip`
|
||
- **macOS**: `ziya-x86_64-apple-darwin.tar.xz` (Intel) or `ziya-aarch64-apple-darwin.tar.xz` (Apple Silicon)
|
||
- **Linux**: `ziya-x86_64-unknown-linux-gnu.tar.xz`
|
||
|
||
### Build from Source
|
||
|
||
If you have Rust installed:
|
||
|
||
```bash
|
||
git clone https://github.com/rizilab/ziya.git
|
||
cd ziya-slint
|
||
cargo install --path .
|
||
```
|
||
|
||
For detailed build instructions, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
|
||
## Quick Start
|
||
|
||
1. **Launch Ziya**: Run the application
|
||
2. **Login**: Enter your credentials or create a new account
|
||
3. **Dashboard**: Browse and search tokens
|
||
4. **Trade**: Access advanced tools in the Hunting Ground
|
||
|
||
## Application Features
|
||
|
||
### Dashboard
|
||
- **Token Search**: Find tokens by name, symbol, or address
|
||
- **Market Overview**: Real-time price data and trends
|
||
- **Portfolio**: Track your holdings and performance
|
||
|
||
### Hunting Ground
|
||
- **Advanced Analysis**: Deep market insights and analytics
|
||
- **Trading Tools**: Professional-grade trading interface
|
||
- **Risk Management**: Built-in tools to manage trading risks
|
||
|
||
### Profile Management
|
||
- **Wallet Integration**: Connect and manage multiple wallets
|
||
- **Settings**: Customize your trading experience
|
||
- **Security**: Secure credential management
|
||
|
||
## Why Slint + Rust?
|
||
|
||
| Aspect | Traditional (Electron) | Ziya (Slint + Rust) |
|
||
|--------|----------------------|-------------------|
|
||
| **Memory Usage** | ~50MB+ | ~10MB |
|
||
| **Startup Time** | 2-5 seconds | Instant |
|
||
| **Bundle Size** | ~100MB | ~5MB |
|
||
| **Performance** | JavaScript V8 | Native machine code |
|
||
| **Security** | Web vulnerabilities | Memory-safe Rust |
|
||
| **Updates** | Large downloads | Efficient delta updates |
|
||
|
||
## Support
|
||
|
||
- **Documentation**: [Full documentation](https://docs.ziya.trading)
|
||
- **Issues**: [GitHub Issues](https://github.com/rizilab/ziya/issues)
|
||
- **Discussions**: [GitHub Discussions](https://github.com/rizilab/ziya/discussions)
|
||
- **Community**: [Discord Server](https://discord.gg/bismillahdao)
|
||
|
||
## Roadmap
|
||
|
||
### Current Version (v0.2.0)
|
||
- ✅ Core trading dashboard
|
||
- ✅ Token search and filtering
|
||
- ✅ User authentication
|
||
- ✅ Basic portfolio tracking
|
||
|
||
### Next Release (v0.3.0)
|
||
- 🚧 Real-time WebSocket data feeds
|
||
- 🚧 Advanced charting with TradingView
|
||
- 🚧 Multi-exchange support
|
||
- 🚧 Trading automation tools
|
||
|
||
### Future Releases
|
||
- 📋 Mobile companion app
|
||
- 📋 DeFi protocol integration
|
||
- 📋 Social trading features
|
||
- 📋 Advanced risk analytics
|
||
|
||
## Contributing
|
||
|
||
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for:
|
||
|
||
- Development setup
|
||
- Code style guidelines
|
||
- Testing procedures
|
||
- Release process
|
||
|
||
## License
|
||
|
||
MIT License - see [LICENSE](LICENSE) file for details.
|
||
|
||
## About bismillahDAO
|
||
|
||
Ziya is proudly developed by [bismillahDAO](https://bismillahdao.org), building ethical and innovative tools for the cryptocurrency community.
|
||
|
||
---
|
||
|
||
**⭐ Star this repository if you find Ziya useful!**
|