projectcaluma/ember-caluma

Ember.js addons for Caluma

The Ember.js addons for Caluma - a collaborative form editing service.

Browser support

last 2 versions	last 2 versions	last 2 versions	last 2 versions

Compatibility

@projectcaluma/ember-* packages are guaranteed to work with the following LTS versions of Ember.js:

• 5.4
• 4.12

Documentation

You can find the interactive documentation here.

Contributing

Installation

• git clone git@github.com:projectcaluma/ember-caluma
• cd ember-caluma
• pnpm install

Linting

• pnpm lint

Running tests

• pnpm --filter @projectcaluma/ember-[package] exec ember test – Runs the test suite on the current Ember version
• pnpm --filter @projectcaluma/ember-[package] exec ember test --server – Runs the test suite in "watch mode"
• pnpm --filter @projectcaluma/ember-[package] exec ember try:each – Runs the test suite against multiple Ember versions

Cross-browser testing provided by:

Running the dummy application

With a mocked Mirage.js backend

• pnpm start
• Visit the dummy application at http://localhost:4200.

With a dockerized Caluma backend

• docker compose up -d
• pnpm start-proxy
• Visit the dummy application at http://localhost:4200.

Updating the schema

The addon includes a mirage server for mocking Caluma's GraphQL API, which is generated from the GraphQL schema definition. If the upstream GraphQL schema changed you can update the addon by running

docker compose up -d
pnpm update-schema
pnpm update-possible-types

Releasing

To release a new version, head over to Actions and trigger a workflow run. This will automatically check if a new version can be released, generate a changelog, draft a release and publish it on NPM.

License

This project is licensed under the LGPL-3.0-or-later license.

For further information on our license choice, you can read up on the corresponding GitHub issue.