Quick Start

Installation

A minimum version of Node.js 22 required, Docker is required for running the database in dev mode.

pnpx fundset init target_dir

The CLI tool witll ask you to choose the settlement layer to use and after that, new fundset template should be initialized. Now you can start shipping!

From Existing Codebase?

You can follow the Manual Installation guide to get started.

Development

Rename the .env.example file to .env and fill in missing environment variables required by your chosen settlement layer.

Then you can run the app in development mode

pnpm dev

and see http://localhost:3000.

Payload CMS Admin panel is available at http://localhost:3000/admin. An admin account is automatically created with the following credentials:

email: admin@admin.com
password: Admin1234

Learn More

New to here? Don't worry, we'll be happy to answer your questions

If you find anything confusing, please give your feedback on Github Discussion!

Fundset Structure

Check out the fundset structure and how to customize it.

Modules

Learn how to implement your own business logic modules.