README.md

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

ember-caluma is guaranteed to work with the last LTS version of Ember.js (currently 3.28).

Documentation

You can find the interactive documentation here.

Contributing

Installation

• git clone [email protected]:projectcaluma/ember-caluma
• cd ember-caluma
• yarn install

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:

Running the dummy application

With a mocked Mirage.js backend

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

With a dockerized Caluma backend

• docker-compose up -d
• yarn 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
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.