Skip to content

About

This is a new project that combines a desktop application framework with web technologies to build a cryptocurrency trading tool build on Electron and React.

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

NeutronTrader Logo

NeutronTrader

A simple, user-friendly Binance trading bot built with Electron and React

GitHub release License PRs Welcome

About

NeutronTrader is a desktop application that allows users to connect to the Binance Testnet API to practice cryptocurrency trading strategies without risking real money. The application provides a clean interface for viewing account balances, price charts, and executing trades based on popular technical indicators.

NeutronTrader Dashboard

Features

  • Binance Testnet Integration: Connect securely to the Binance Testnet API for paper trading
  • Real-time Dashboard: View your account balances and price charts
  • Multiple Trading Strategies:
    • Simple Moving Average (SMA)
    • Relative Strength Index (RSI)
    • Bollinger Bands
  • Customizable Trading Parameters:
    • Set trading pair
    • Define trade amount
    • Configure take profit and stop loss percentages
    • Set trading intervals
  • Trade History Tracking: Monitor your executed trades and performance
  • Diagnostic Tools: Troubleshoot API connectivity issues

Installation

Prerequisites

  • Node.js 14+
  • npm 6+

Setup

# Clone the repository
git clone https://github.com/yourusername/NeutronTrader.git

# Navigate to the project directory
cd NeutronTrader

# Install dependencies
npm install

# Start the application
npm start

Usage

  1. Get Testnet API Keys:

    • Register at Binance Testnet
    • Generate API keys with "TRADE, USER_DATA, USER_STREAM" permissions
  2. Connect to Testnet:

    • Enter your API keys in the application
    • Dashboard will show your account balances and price chart
  3. Configure Trading Bot:

    • Go to the Setup tab
    • Select trading pair (e.g., BNB/USDT)
    • Choose strategy
    • Set trade amount and parameters
    • Start the bot
  4. Monitor Trades:

    • View executed trades in the History tab
    • Check performance metrics
    • Analyze trade patterns

Architecture

NeutronTrader uses Electron's main process to make API calls to Binance, avoiding CORS restrictions that would affect browser-based applications. The React UI communicates with the main process via IPC (Inter-Process Communication).

  • Main Process: Handles Binance API calls securely
  • Renderer Process: React-based UI for user interaction
  • IPC Bridge: Secure communication between processes

Contributing

We welcome contributions from developers of all skill levels! Check out our CONTRIBUTING.md guide to get started.

Good First Issues: Looking to make your first contribution? Check issues labeled with good first issue - these are specifically designed for new contributors.

See our roadmap for planned features and improvements.

Security

NeutronTrader currently connects only to the Binance Testnet, which uses test tokens with no real value. The application handles API keys securely, storing them only in the local environment.

⚠️ Warning: This is an alpha release intended for testing and educational purposes. Do not use with real funds or API keys from the main Binance network.

Acknowledgements

  • Binance for providing the Testnet API
  • Electron for the desktop application framework
  • React for the UI components
  • Recharts for the charting library

About

This is a new project that combines a desktop application framework with web technologies to build a cryptocurrency trading tool build on Electron and React.

Resources

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages