BTC Tracker

Using Docker (Recommended)

The easiest way to run BTC Tracker is using Docker. Make sure you have Docker installed on your system.

Quick Start with Docker Run

docker pull docker.io/thewilqq/btc-tracker:latest
docker run -d -p 3000:3000 -v ./data:/app/src/data docker.io/thewilqq/btc-tracker:latest

This will start application on localhost:3000 and use ./data as the data directory.

Using Docker Compose (Recommended)

For more configuration options, create a docker-compose.yml file with the following content:

services:
  btc-tracker:
    image: docker.io/thewilqq/btc-tracker:latest
    container_name: ${CONTAINER_NAME:-btc-tracker}
    ports:
      - "${PORT:-3000}:3000"
    volumes:
      - ${DATA_PATH:-./data}:/app/src/data
    restart: unless-stopped
    environment:
      - NODE_ENV=${NODE_ENV:-development}
      - PORT=3000

Then run the application with:

docker-compose up -d

Configuration Options

You can customize the following environment variables:

• CONTAINER_NAME: Name of the container (default: btc-tracker)
• PORT: Port to access the application (default: 3000)
• DATA_PATH: Local path to store application data (default: ./data)
• NODE_ENV: Environment setting (default: development)

Manual Installation

If you prefer to run BTC Tracker without Docker, follow these steps:

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Installation Steps

# Clone the repository
git clone https://github.com/wilqq-the/btc-tracker.git
cd btc-tracker

# Install dependencies
npm install

# Start the application
npm start

The application will be available at http://localhost:3000.

First-Time Setup

When you first access BTC Tracker, you'll need to create an admin account:

1. Open your browser and navigate to http://localhost:3000
2. You'll be redirected to the setup page
3. Create an admin username and password
4. Log in with your new credentials

After setup, you'll be able to add transactions, view your Bitcoin portfolio, and track your investment performance.