You need to have the following tools installed to run the local development server:
- Node >= 20
- NPM
- Docker client
Fastest way to getting a dev server running on your local machine is to run the following bash script in your terminal from the repo top directory.
./dev-setup.shdApps monorepo is built on Turbo repo for faster npm script execution through caching and parallelization.
Run npm scripts from the repo top directory
npm installnpm run devnpm run pre-pushnpm run testSearch for addresses and transactions on the Radix Network. Participate in Radix Network staking using XRD tokens.
A collection of utility pages to help you during development of your own dApps.
A configurable dApp frontend simulator to let you experiment with Radix Wallet logins and requests for data. Development environment contains additional pages which can be used to play around with various wallet and network features.
Wrapper package for dependencies reused in different dApps. It contains dependencies that almost every Radix-based project needs like RDT, Gateway SDK, Core SDK, Rola, RET.
Set of svelte components reused between Dev Console and Dashboard apps. Contains main dApp layout - header, side menu and other smaller components.
Custom ESLint configuration used by other packages and apps.
Each app is a SvelteKit application. The default adapter is @sveltejs/adapter-node, which produces a standalone Node.js server. But, you can easily deploy to a serverless environment like Vercel, instructions are included below.
The apps use the following environment variables (set via .env files or your platform's environment configuration):
| Variable | Description |
|---|---|
PUBLIC_NETWORK_NAME |
Radix network to target (e.g. mainnet, stokenet) |
PUBLIC_DAPP_DEFINITION_ADDRESS |
dApp definition address (optional, overrides the default for the selected network) |
PUBLIC_AMPLITUDE_API_KEY |
Amplitude analytics key (optional) |
PUBLIC_APP_ENV |
App environment identifier (e.g. production, development) |
Each deployed instance of Console or Dashboard needs a dApp definition on the Radix Network. To set one up:
- Follow the dApp Definition Setup Guide to create a dApp definition account on the network you are targeting.
- Set the
PUBLIC_DAPP_DEFINITION_ADDRESSenvironment variable to the address of the account you created.
If left empty, the apps will fall back to the default addresses defined in packages/ui/src/constants.ts, which do not point to your front-end and will cause errors.
Build and run an individual app:
npm install
npx turbo run build --filter=dashboard
node apps/dashboard/buildReplace dashboard with console or sandbox as needed.
The build output is written to apps/<app>/build/ by default. The Node.js server listens on port 3000 (configurable via the PORT environment variable).
To deploy on Vercel, you need to switch SvelteKit from the Node adapter to the Vercel adapter:
-
In
packages/ui/svelte.config.js, change the import from@sveltejs/adapter-nodeto@sveltejs/adapter-vercel, and changeadapter: adapter({ out: 'build' })toadapter: adapter(). -
In the
devDependenciesof each app'spackage.json(apps/console/package.json,apps/dashboard/package.json) andpackages/ui/package.json, replace"@sveltejs/adapter-auto"with"@sveltejs/adapter-vercel": "^5". -
Deploy on Vercel (repeat for each app you want to deploy):
- Go to vercel.com and open your dashboard.
- Click Add New → Project.
- Select this repository (fork/clone it to your GitHub account first if needed). Vercel should automatically detect it as a Turborepo monorepo.
- Under Root Directory, change it to the app you want to deploy (e.g.
apps/dashboard,apps/console, orapps/sandbox). - Configure the environment variables listed above under Environment Variables.
- Click Deploy.
You need to create a separate Vercel project for each app you want to deploy.