Skip to content

quick-start.md

Latest commit

 

History

History
120 lines (84 loc) · 2.82 KB

quick-start.md

File metadata and controls

120 lines (84 loc) · 2.82 KB

Quick Start Guide

Get Ashfolio running and explore its features in 10 minutes!

Prerequisites Check

Before starting, ensure you have:

  • Elixir 1.14+ and Erlang/OTP 25+
  • macOS (currently optimized for Apple Silicon)
  • brew install just

Need to install these? See the Installation Guide

5-Minute Setup

  1. git clone https://github.com/mdstaff/ashfolio.git
cd ashfolio
  2. just dev

    This installs dependencies, sets up the database, and starts the Phoenix server

Explore the Features

📊 Dashboard

  • Total worth of all holdings
  • Gains/losses with color coding (green = gains, red = losses)
  • Complete view of all positions with current prices

💰 Account Management

  • Navigate to "Accounts" to see investment accounts (Schwab, Fidelity, etc.)
  • Click "New Account" to add your own
  • Include/exclude accounts from portfolio calculations

📈 Transaction Management

  • Navigate to "Transactions" to see all investment activity
  • Click "New Transaction" to record buys, sells, dividends
  • BUY, SELL, DIVIDEND, FEE, INTEREST, LIABILITY

💱 Price Updates

  • Use the refresh button on the dashboard
  • Prices are fetched from Yahoo Finance API
  • Prices are cached for performance

Development Commands

# Essential development commands
just dev                    # Start everything (most common)
just server                # Start server only (if already set up)
just test                  # Run test suite
just test-fast             # Quick tests for development
just format                # Format code
just check                 # Format + compile + test

Sample Data Overview

The pre-seeded database includes:

  • Default local user
  • Schwab Brokerage, Fidelity 401k, Crypto Wallet
  • AAPL, MSFT, GOOGL, SPY, VTI, BTC-USD, TSLA, NVDA
  • Mix of buys, sells, and dividends for realistic portfolio

Next Steps

Now that Ashfolio is running:

  1. Click through all the pages and features
  2. Read the Architecture Overview
  3. Follow the First Contribution Guide
  4. Try just test-fast to see the testing framework

Common Issues

Port Already in Use

# Kill existing Phoenix server
pkill -f "phx.server"
# Or use a different port
PORT=4001 just server

Database Issues

# Reset database
just reset
# Or backup and restore
just backup
just restore

Test Failures

# Run database health check
just test-health-check
# Reset test database if needed
just test-db-emergency-reset

Having issues? Check the Troubleshooting Guide Ready to contribute? See First Contribution Guide