Skip to content

About

πŸ“‰ Providing enhanced visibility into short positions on the Australian Stock Exchange

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Latest commit

Β 

History

4,083 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Shorted.com.au

A platform for tracking short selling positions in the Australian stock market, providing real-time data from ASIC and comprehensive company analytics.

Quick Start

# Install dependencies
make install

# Start all services (database + backend + frontend)
make dev

# Visit http://localhost:3020

Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                              Frontend                                    β”‚
β”‚                    Next.js 14 (Vercel) - Port 3020                      β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                      β”‚
                    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                    β”‚                                   β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚       Shorts API              β”‚   β”‚     Enrichment Processor      β”‚
β”‚   Go + Connect-RPC - 9091     β”‚   β”‚     Python/Go - Cloud Run     β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                    β”‚
          β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”
          β”‚                 β”‚
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”  β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”
β”‚    PostgreSQL     β”‚  β”‚ Algolia β”‚
β”‚    (Supabase)     β”‚  β”‚ Search  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Services

Service Port Description Command
Frontend 3020 Next.js web application make dev-frontend
Shorts API 9091 Short position data API (Connect-RPC) make dev-backend
Database 5438 PostgreSQL (local Docker) make dev-db
Enrichment - Company metadata enrichment make dev-enrichment-processor

Development

Prerequisites

  • Node.js 20+
  • Go 1.23+
  • Docker & Docker Compose
  • (Optional) Stripe CLI for payment testing

Commands

# Development
make dev                  # Start all services
make dev-frontend         # Frontend only
make dev-backend          # Backend only
make dev-db               # Database only
make dev-stop             # Stop all services
make clean-ports          # Kill stale processes

# Testing
make test                 # Run all tests (lint + unit + integration)
make test-frontend        # Frontend tests only
make test-backend         # Backend tests only
make test-integration     # Integration tests with testcontainers

# Database
make populate-data        # Download and populate ASIC short data
make db-diagnose          # Diagnose query performance
make db-optimize          # Apply performance indexes

# Code Quality
make lint                 # Run linting (TypeScript + Go)
make format               # Format all code

Local Database

Host:     localhost:5438
Database: shorts
Username: admin
Password: password

Project Structure

shorted/
β”œβ”€β”€ web/                    # Next.js frontend
β”‚   β”œβ”€β”€ src/app/           # App router pages
β”‚   β”œβ”€β”€ src/@/components/  # Shared components (shadcn)
β”‚   └── src/gen/           # Generated protobuf types
β”œβ”€β”€ services/              # Go backend services
β”‚   β”œβ”€β”€ shorts/            # Main API service
β”‚   β”œβ”€β”€ enrichment-processor/  # Company enrichment
β”‚   β”œβ”€β”€ jobs/              # Consolidated `shorted <job>` binary (incl. ASIC sync)
β”‚   └── migrations/        # Database migrations
β”œβ”€β”€ proto/                 # Protobuf API definitions
β”œβ”€β”€ terraform/             # Infrastructure as code
β”‚   β”œβ”€β”€ environments/      # dev, prod configs
β”‚   └── modules/           # Reusable modules
β”œβ”€β”€ analysis/              # Python data analysis scripts
└── docs/                  # Documentation

Tech Stack

Layer Technology
Frontend Next.js 14, TypeScript, TailwindCSS, Radix UI
Backend Go 1.23, Connect-RPC (gRPC-Web)
Database PostgreSQL (Supabase), Firestore (user data)
Search Algolia
Auth NextAuth.js v5, Firebase, Google OAuth
Payments Stripe
Infrastructure GCP Cloud Run, Terraform
CI/CD GitHub Actions, Vercel

Documentation

Document Description
Production Deployment Deploy to production guide
Terraform Guide Infrastructure management
API Reference API documentation

Deployment

Environments

Environment Trigger GCP Project
Local development Local commands None
Pull request Terraform review plan only Production state, no apply
Production Push to main, release, or approved manual run rosy-clover-477102-t5

Deploy to Production

# Create release tag
git tag v1.0.0
git push origin v1.0.0

# Create Release in GitHub UI to trigger deployment

See Production Deployment Guide for full details.

Environment Variables

Required for Development

# Database (local)
DATABASE_URL=postgresql://admin:password@localhost:5438/shorts

# Algolia (search)
ALGOLIA_APP_ID=your-app-id
ALGOLIA_SEARCH_KEY=your-search-key

# Auth (optional for local dev)
NEXTAUTH_SECRET=your-secret
AUTH_GOOGLE_ID=your-client-id
AUTH_GOOGLE_SECRET=your-client-secret

Required for Production

See docs/PRODUCTION_DEPLOYMENT.md for full list.

Stripe Test-Mode Checkout Smoke Bench

Run the isolated Stripe checkout smoke bench locally:

# Required (test mode)
export STRIPE_TEST_SECRET_KEY=sk_test_...
export STRIPE_TEST_PRO_PRICE_ID=price_...

# Optional legacy alias during migration
# export STRIPE_TEST_PRICE_ID=price_...

npm run test:e2e:stripe:testmode

The bench:

  • Signs in with the E2E credentials fallback.
  • Opens /pricing.
  • Creates a Stripe checkout session via /api/stripe/checkout.
  • Verifies redirect to checkout.stripe.com.

Notes:

  • This is a checkout smoke test only and does not submit card details or confirm payment.
  • It can create Stripe checkout sessions in your Stripe account.
  • The workflow .github/workflows/stripe-testbench.yml runs this in CI only when Stripe test secrets are configured.
  • Canonical Premium price env is STRIPE_PREMIUM_PRICE_ID; STRIPE_PRO_PRICE_ID remains a legacy fallback.
  • Dedicated API Access checkout price env is STRIPE_API_ACCESS_PRICE_ID.

Contributing

# 1. Create feature branch
git checkout -b feature/my-feature

# 2. Make changes and test
make test

# 3. Push and create PR
git push origin feature/my-feature

License

Proprietary - All rights reserved.

About

πŸ“‰ Providing enhanced visibility into short positions on the Australian Stock Exchange

Topics

Resources

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages