Skip to content

QUICKSTART.md

Latest commit

 

History

History
93 lines (68 loc) · 2.64 KB

QUICKSTART.md

File metadata and controls

93 lines (68 loc) · 2.64 KB

Quick Start Guide

Fastest Way to Run

Prerequisites

  1. Install Java 11 or higher
  2. Install Maven (recommended) or download dependencies manually

Build and Run (with Maven)

# Make scripts executable (Linux/Mac)
chmod +x build.sh run.sh

# Build the project
./build.sh

# Run the application
./run.sh

Or use Maven directly:

mvn clean package
java -jar target/crypto-trading-client-1.0-SNAPSHOT-jar-with-dependencies.jar

Windows Users

mvn clean package
java -jar target\crypto-trading-client-1.0-SNAPSHOT-jar-with-dependencies.jar

First Time Usage

  1. App Launches: You'll see a demo account with $10,000 created automatically
  2. Browse Tokens: Left panel shows top 100 cryptocurrencies
  3. Click a Token: View its price chart and details
  4. Try Trading:
    • Click green "Buy" button to purchase crypto
    • Click red "Sell" button to sell (if you own some)
  5. Check P&L: Bottom right shows your account's profit/loss chart

Key Shortcuts

  • Account Menu → Create/switch accounts, view all accounts
  • Wallet Menu → Deposit/withdraw funds
  • Trading Menu → View watchlist, open positions
  • ★ Watch Button → Add crypto to your watchlist
  • Refresh Button → Update market data

File Structure

crypto-trading-client/
├── *.java                  # All Java source files
├── pom.xml                 # Maven configuration
├── build.sh                # Build script (Linux/Mac)
├── run.sh                  # Run script (Linux/Mac)
├── README.md               # Full documentation
├── QUICKSTART.md           # This file
└── accounts/               # Created automatically for account data
    └── *.json              # Account files (created on first use)

Common Issues

"Maven not found": Install Maven from https://maven.apache.org/download.cgi

"Java not found": Install Java 11+ from https://adoptium.net/

API errors: Check internet connection; CoinGecko API is free but rate-limited

Chart not showing: Make sure dependencies compiled correctly with Maven

Testing the App

  1. Create a new account (Account → Create Account)
  2. Buy some Bitcoin or Ethereum
  3. Watch the P&L chart update (bottom right panel)
  4. Check open positions (Trading → Open Positions)
  5. Add cryptos to watchlist and view them (Trading → Watchlist)

Demo Features to Try

  • Create multiple accounts and compare performance
  • Simulate different trading strategies
  • Track 24-hour P&L movements
  • Use the search box to find specific tokens
  • Watch real-time price changes (refresh button)

Enjoy your crypto trading simulation! 🚀