Skip to main content

Getting Started

Requirements​

Minimum requirements: npm (v7 or above) and Node.js (v12 or above).

Installing Dependencies​

Once you clone and open the repo in the IDE of your choice, first install the dependencies:

npm install

If any dependency-related issues arise, try a clean install:

npm run install:clean

Local Development​

Demo App​

If you're making changes to the core library @unovis/ts, we recommend creating at least one example using our local demo app to visually test your changes. Add the example to packages/dev/src/examples in the appropriate category folder.

To start the development server for the demo app, run the command:

npm run dev

Website​

To start the development server for the website, run the command:

npm run website

Framework Apps​

Each framework wrapper* has a demo app to verify our gallery examples work as expected. To run the app for a specific framework, navigate to that directory within packages and run the command:

npm run gallery