PaperDEX

PaperDEX is a paper trading cryptocurrency exchange that allows users to simulate real-world crypto trading using virtual funds.
It supports market and limit order types and fetches real-time order book data from Binance for an authentic trading experience.

Tech Stack

• Monorepo Management: Turborepo
• Front End: Next.js
• Backend Framework: Express.js (per service)
• Database ORM: Prisma
• Database: PostgreSQL
• Authentication: better-auth

Features

• 🔐 User Authentication (Register, Login)
• 💵 Virtual Wallets for USDT, BTC, and more
• 📈 Real-time Order Book (Binance mirror)
• 📊 Market & Limit Orders

Monorepo Structure

PaperDEX/
├── .devcontainer/            # Devcontainer config for VS Code remote development
├── .github/                  # GitHub workflows and issue templates
├── vscode/                   # VS Code settings
├── apps/
│   └── web/                  # Frontend application built with Next.js
├── deploy/                   # Deployment-related files/scripts
├── packages/                 # Shared and backend services
│   ├── db/                   # Prisma schema and database utilities
│   ├── eslint-config/        # Shared ESLint configuration
│   ├── lib/                  # Shared libraries (e.g., utils, email, error handlers)
│   ├── order-service/        # Microservice for order management and matching engine
│   ├── typescript-config/    # Shared TypeScript configurations
│   └── user-service/         # Microservice for user authentication and management
├── .dockerignore             # Specifies files to ignore in Docker build context
├── .env.example              # Example environment variables file
├── .gitignore                # Specifies files to ignore in Git
├── .npmrc                    # NPM configuration file
├── .prettierrc               # Prettier configuration file
├── docker-compose.yml        # Docker Compose config for running services
├── package.json              # Root package metadata and scripts
├── pnpm-lock.yaml            # Lockfile for reproducible installs (pnpm)
├── pnpm-workspace.yaml       # Workspace definitions for monorepo (pnpm)
├── README.md                 # Project documentation
├── turbo.json                # Turborepo configuration

Getting Started

To get started with PaperDEX, follow these steps:

1. Clone the repository:

   git clone https://github.com/sutaro/PaperDEX.git
   cd PaperDEX

2. Set up environment variables:

   • Navigate to each workspace (inside apps/ or packages/)
   • Copy the .env.example file to .env in each relevant workspace
   • Update the environment variables as needed

   Example .env structure:

   # App environment
   NODE_ENV=production
   
   # Ports
   USER_SERVICE_PORT=4001
   
   # PostgreSQL database URLs
   DIRECT_URL=postgresql://<user>:<password>@<host>:<port>/<db>
   DATABASE_URL=postgresql://<user>:<password>@<host>:<port>/<db>?pgbouncer=true
   
   # Auth secrets
   BETTER_AUTH_SECRET=<your_better_auth_secret>
   
   # Google OAuth credentials
   GOOGLE_CLIENT_ID=<your_google_client_id>
   GOOGLE_CLIENT_SECRET=<your_google_client_secret>
   
   # Email service
   RESEND_API_KEY=<your_resend_api_key>
   EMAIL_FROM=noreply@paperdex.in
   
   # Service URLs
   BETTER_AUTH_URL=https://user-service.paperdex.in
   NEXT_PUBLIC_CLIENT_SERVICE=https://paperdex.in
   NEXT_PUBLIC_USER_SERVICE=https://user-service.paperdex.in
   NEXT_PUBLIC_ORDER_SERVICE=https://order-service.paperdex.in
   NEXT_PUBLIC_AUTH_SERVICE=https://user-service.paperdex.in
   
   # Redis
   REDIS_URL=redis://<username>:<password>@<host>:<port>

3. Install dependencies:

   pnpm install

4. Run the application:

   pnpm dev

💡 Make sure you have pnpm installed on your system before proceeding.

Contributing

PRs, ideas, and discussions are welcome! Please open an issue if you have suggestions or find bugs.

License

MIT © 2025 PaperDEX Team