Modelence

Website | Documentation | API Reference | Modelence Cloud

!Build Status

For a more detailed guide, check out the Quick Start section in our documentation.

Local Development (Modelence Framework)

If you want to contribute to Modelence itself (not just use it in an application), follow the steps below.

Before you start, please read CONTRIBUTING.md.

Bug fixes and small improvements are welcome as pull requests; changes to the core runtime or public API surface

should start with an issue.

1. Clone the repository

git clone https://github.com/modelence/modelence.git
cd modelence

2. Install dependencies for the core package

cd packages/modelence
npm install

3. Build the package

npm run build

This generates the dist/ directory required for local usage.

4. (Optional) Watch for changes during development

npm run dev

This runs the build in watch mode and rebuilds on file changes.

Note

> If you encounter dependency or build errors while developing Modelence locally, a clean install may help:

>

> rm -rf node_modules package-lock.json

> This resets the local dependency state and mirrors the workflow often recommended when resolving local development issues.

The regenerated package-lock.json is only for local development and should not be committed as part of a PR unless explicitly requested.

Using the local build in a test app

To test your local Modelence changes inside a real application:

npx create-modelence-app@latest my-app
cd my-app

Update package.json to point to your local Modelence package:

{
  "dependencies": {
    "modelence": "../modelence/packages/modelence"
  }
}

Then reinstall dependencies and start the app:

npm install
npm run dev

Your application will now use your local Modelence build.

Examples

For more examples on how to use Modelence, check out https://github.com/modelence/examples