@antimatterhq/onboarding
v0.5.14-rc5
Published
# How to run project * Run `yarn` to install all packages * Add a `.env` file at the root of the project with `VITE_API_URL=<SERVER_API_URL>` (example: `http://subdomain.domain.com/antimatter-api/v1`) * Run `yarn dev` to run the project, it should open on
Downloads
57
Keywords
Readme
Onboarding UI
How to run project
- Run
yarn
to install all packages - Add a
.env
file at the root of the project withVITE_API_URL=<SERVER_API_URL>
(example:http://subdomain.domain.com/antimatter-api/v1
) - Run
yarn dev
to run the project, it should open onhttp://localhost:5173
How to use the Widget
- Run
npm install @antimatterhq/onboarding
import { Onboarding } from '@antimatterhq/onboarding'
<Onboarding name={name} externalId={id} apiUrl={SERVER_API_URL} />