TraderMemos
Getting started

Quick start

Run the web UI and API in one container, on your own machine.

Web UI and API on your own machine, using the published Docker images:

git clone https://github.com/sinhong2011/TraderMemos.git
cd TraderMemos
make up          # → http://localhost:3000

That's it. Same-origin /api — no CORS, leave the Server field blank. On first visit the setup wizard creates your owner account — then head to First steps.

Without cloning the repo

Only Docker installed, no git or make? The compose file pulls prebuilt images, so it's all you need:

mkdir tradermemos && cd tradermemos
curl -fsSLO https://raw.githubusercontent.com/sinhong2011/TraderMemos/main/docker-compose.yml
docker compose up -d       # → http://localhost:3000

Options and production notes

cp .env.example .env   # optional: DOCKERHUB_USERNAME, TM_IMAGE_TAG
make up                # pull prebuilt images from Docker Hub
make up-build          # or build both images from this repo
make up-postgres       # SQLite → Postgres overlay

For production, set TM_JWT_SECRET=$(openssl rand -hex 32) and put TLS in front — see Deploy and Reverse proxy. All server settings are in the Configuration reference.

Local development

git clone https://github.com/sinhong2011/TraderMemos.git
cd TraderMemos
make setup && make dev   # API :8080 + web :5173

See CONTRIBUTING.md for targets, Vite+ commands, and project structure.

Demo data

Fill any instance with ~200 generated trades over the last three months:

make demo-seed API=http://localhost:3000/api/v1 EMAIL=you@example.com PASSWORD='…'

It talks to the public API only, so it works against a local stack or a deployed demo. Re-running is a no-op — fills are deduplicated server-side.

On this page