Getting Started

Set up your RocketX developer environment and make your first strategy submission.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 20+
• npm (comes with Node.js)
• MongoDB (running locally or a connection string to MongoDB Atlas)

1. Clone the Repository

git clone <your-repo-url>
cd rocketx-api

2. Environment Setup

Copy the example environment file to create your local configuration.

cp .env.example .env

Critical Variables

Both apps/web and apps/api share secrets — these must match:

• SESSION_SECRET — long random string used to sign session cookies.
• ENCRYPTION_KEY — 32-byte (64-character hex) key for encrypting sensitive data.
• MONGO_URI — your MongoDB connection string.
• RESEND_API_KEY — required for OTP and Magic Link emails.

GitHub App Variables (Developer Features)

To enable GitHub repository browsing and commit-pinned submissions:

• GITHUB_APP_ID — your GitHub App's numeric ID.
• GITHUB_APP_PRIVATE_KEY — PEM private key with \n escaped (PKCS#1 RSA key supported).
• GITHUB_APP_SLUG — the slug of your GitHub App.
• GITHUB_WEBHOOK_SECRET — webhook validation secret.

3. Install Dependencies

npm install

4. Run Development Servers

npm run dev

By default:

• Web App: http://localhost:4215
• API Server: https://api.rocketx.market
• API Docs (Scalar): https://api.rocketx.market/v1/docs

5. Submit Your First Strategy

1. Register an account and log in.
2. Navigate to Developer in the sidebar.
3. Click New Strategy and fill in the name, description, and tags.
4. On the strategy page, open the Versions tab and click Submit Version.
5. Connect your GitHub account if prompted, pick a repository and commit, then fill in version details.
6. Submit — RocketX will run the review pipeline automatically.

Next Steps

See the Project Structure guide to understand how the codebase is organized.