Controtto

🚀 Self-hosted Investment P&L Tracking Tool - Controtto

Controtto is a self-hosted P&L (Profit and Loss) tracking tool developed in Go, combined with HTMX and implemented without JavaScript. It stores transaction records in SQLite files and offers various calculation functions:

• Average buy price
• Current asset value
• Transaction history
• Import/Export transaction data (refer to the example file)
• Profit and loss calculation

To obtain asset prices, Controtto uses four main APIs:

• Binance: A public API that doesn't require a token.
• BingX: A public API that doesn't require a token.
• Alpha Vantage: Provides stock data. It's free but has rate limits. Please obtain a token and set the CONTROTTO_AVANTAGE_TOKEN environment variable.
• Tiingo: Provides data for stocks, cryptocurrencies, and foreign exchange. Please create an account, obtain a token, and then set the CONTROTTO_TIINGO_TOKEN environment variable.

🚀 Quick Start

🔍 Demo

You can view a live demo at demo.contre.io. The database resets every hour.

📦 Installation

# Install dependencies
go mod tidy

# Configure the environment file
mv .env.example .env

# Read environment variables
. <(cat .env | grep -v -e '^$' | grep -v "#" | awk '{}')

🚀 Build and Run

go run ./cmd/main.go # Or build an executable file: go build ./cmd/main.go

💻 Development Environment Configuration

# Install the Air tool
go install github.com/cosmtrek/air@latest

# Start the application using Air
air -c air.toml

# Access http://localhost:3000 to view the results

🐳 Run Container with Podman

We provide a Docker image at hub.docker.com/r/contre95/controtto. If you want to use it, replace podman with docker.

mkdir data

# Start the container
podman container run --rm -p 8000:8000 -v $(pwd)/data:/data contre95/controtto

🧪 Testing

go test -cover ./...

# Example of expected results:
# ?       controtto/cmd   [no test files]
# ?       controtto/src/app/managing      [no test files]
# ?       controtto/src/domain/pnl        [no test files]
# ?       controtto/src/gateways/markets  [no test files]
# ?       controtto/src/gateways/sqlite   [no test files]
# ?       controtto/src/presenters        [no test files]
# ok      controtto/src/app/querying      0.003s  coverage: 40.7% of statements

📋 TODO

• Add more test cases.
• Add logging and monitoring features.
• Implement account management functionality to track the total net worth.
• Remove all CSS and use a custom style.css and Tailwind CDN.