Mayson Monorepo Documentation
    Preparing search index...

    Mayson Monorepo Documentation

    💬 Mayson

    CI Status TypeScript pnpm License

    🚀 AI-powered conversational investment platform

    Invest in crypto, stocks, ETFs, forex, and commodities through natural conversation with built-in safety, compliance, and education features.


    • 🧠 Natural Language Trading — Execute trades using conversational commands
    • 👻 Ghost Trading — Risk-free paper trading simulator for learning
    • 🔐 Secure Exchange Integration — Connect your exchange accounts with encrypted API keys
    • Real-time Market Data — Live prices and portfolio tracking
    • 🛡️ Safety Guardrails — Built-in position limits and risk management
    • 📊 Usage Tracking — Monitor AI usage and costs
    • 📱 Cross-Platform — Web, iOS, and Android apps

    Category Technology
    🖥️ Frontend Next.js 16, React, Tailwind CSS, shadcn/ui
    ⚙️ Backend Express.js, TypeScript, Node.js
    🗄️ Database MongoDB (Mongoose)
    🔴 Cache/Queue Redis
    🔑 Auth Kinde
    🤖 AI OpenRouter (Claude, GPT-4)
    🔧 Tooling pnpm, Biome, Docker

    App Description Port
    🌐 frontend Next.js web application 3000
    📱 mobile Expo React Native app 8081
    api Express REST API server 3001
    worker Background job processor
    🌍 website Marketing website (Next.js) 3003

    • Node.js 20+
    • pnpm 10+
    • MongoDB instance
    • Redis instance
    • Kinde account for authentication
    # Clone the repository
    git clone [email protected]:avatarsglobal/project-mayson-monorepo.git
    cd mayson-monorepo

    # Install dependencies
    pnpm install

    Copy the example environment files and configure them:

    # Frontend
    cp apps/frontend/.env.local.example apps/frontend/.env.local

    # API
    cp apps/api/.env.example apps/api/.env

    # Worker
    cp apps/worker/.env.example apps/worker/.env
    App Env File Key Variables
    🌐 frontend .env.local KINDE_CLIENT_ID, KINDE_CLIENT_SECRET, KINDE_ISSUER_URL
    🔧 api .env PORT, KINDE_ISSUER_URL, ENCRYPTION_KEY
    ⚡ worker .env REDIS_HOST, REDIS_PORT, REDIS_PASSWORD
    # Run all apps concurrently
    pnpm dev

    # Or run individually
    pnpm --filter frontend dev # Frontend on :3000
    pnpm --filter mobile start # Mobile on :8081
    pnpm --filter api dev # API on :3001
    pnpm --filter worker dev # Worker
    pnpm --filter website dev # Website on :3003

    Command Description
    pnpm dev Start all apps in development mode
    pnpm check Run Biome linting and formatting checks
    pnpm check:fix Fix linting and formatting issues
    pnpm format Format codebase with Biome
    pnpm lint Run linter
    # Add dependency to specific app
    pnpm add <package> --filter frontend
    pnpm add <package> --filter api

    # Run commands in specific app
    pnpm --filter frontend <command>
    pnpm --filter api <command>

    Docker images are available for deployment:

    # Build images
    docker build -f Dockerfile.frontend -t mayson-frontend .
    docker build -f Dockerfile.api -t mayson-api .

    Document Description
    Investor Whitepaper Business overview, market opportunity, and investment information
    Technical Whitepaper Detailed architecture, module specifications, and design decisions

    This project is proprietary software. All rights reserved.


    💬 Mayson - Making investing as easy as conversation.