Skip to content

projectcaluma/ember-caluma

Repository files navigation

ember-caluma

Test BrowserStack Status Codecov Code Style: Prettier License: LGPL-3.0

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

Browser support

Edge Firefox Chrome Safari
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:

  • 4.4
  • 3.28

Documentation

You can find the interactive documentation here.

Contributing

Installation

Linting

  • yarn lint

Running tests

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

Cross-browser testing provided by:

BrowserStack

Running the dummy application

With a mocked Mirage.js backend

With a dockerized Caluma backend

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
yarn update-schema
yarn 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.