ParaX Mini App Template

Usage

This is a sub-project and it can't run on its own. It needs to be integrated into the main project.

1. Dev

1.1 Link

Make the main project link to this sub-project

# cd <this project>
cd <your-sub-project-dir>
pnpm install
pnpm build # or pnpm dev
pnpm link --dir <your-main-project-dir>
# example: pnpm link --dir ../parax

Once the sub-project is linked, you can run the main project to see the changes.

Note: You need to run pnpm build every time you make changes to the sub-project

1.2 Unlink

cd <your-main-project-dir>
pnpm unlink <your-sub-project-dir>
# example: pnpm unlink ../parax-mini-app

# or
cd <your-sub-project-dir>
pnpm unlink --dir <your-main-project-dir>
# example: pnpm unlink --dir ../parax

2. Prod

Publish as a npm package (e.g. parax-mini-app), and install it in the main project

pnpm add parax-mini-app

3. Integration

import miniApp from 'parax-mini-app';
import { AppPackage } from 'parax-sdk';

const miniAppPKG: AppPackage = { ...miniApp, icon: `design/logo/${miniApp.icon}` }