Skip to main content

Prerequisites

Before installing Raze, ensure you have the following:

Node.js

Version 18 or later recommended

npm

Comes bundled with Node.js
Verify your Node.js version by running node --version in your terminal

Quick Start

1. Clone the Repository

2. Install Dependencies

3. Start Development Server

The development server will start at http://localhost:5173

One-Click Deployment

Prefer not to run locally? Deploy instantly to the cloud:

Deploy with Vercel

Zero-config deployment

Deploy with Netlify

Continuous deployment

Production Build

Build for Production

This command will:
  1. Run TypeScript type checking
  2. Generate HTML from templates
  3. Bundle and optimize the application

Preview Production Build

Deploy the dist Folder

After building, deploy the contents of the dist folder to your hosting provider.

Available Scripts

Project Structure

Configuration

Environment Setup

Raze uses a configuration system stored in the browser. Key settings include:
array
Configure multiple RPC endpoints with weighted load balancing
string
Optional self-hosted trading server URL
string
Data stream API key for real-time market data

Brand Configuration

Customize branding by editing brand.json:
After editing, regenerate HTML:

Theme Customization

Edit green.css or create a new theme file:

Troubleshooting

The dev server defaults to port 5173. If it’s in use, Vite will automatically try the next available port. You can also specify a port:
Ensure you’re using Node.js 18 or later:
Consider using nvm to manage Node.js versions.
Run type checking separately to see detailed errors:
Configure multiple RPC endpoints in Settings for redundancy. The app will automatically rotate between endpoints if one fails.

Next Steps

Technical Integration

Embed Raze in your application

Key Features

Explore all features