@appuniversum/ember-appuniversum
v3.7.0
Published
Ember addon wrapping the appuniversum components.
Downloads
1,766
Keywords
Readme
@appuniversum/ember-appuniversum
Ember addon that provides components for Flanders themed applications.
Compatibility
- Ember.js v4.12 or above
- Ember CLI v4.12 or above
- Node.js v18 or above
Installation
npm install --save-dev @appuniversum/ember-appuniversum
Usage
This ember addon wraps a CSS framework for Flanders government applications called Appuniversum. It provides components that helps being compliant with this framework in Ember apps.
To get started using this addon in your Ember.js app, follow the Getting started guide.
Contributing
See the Contributing guide for details.
Development
Running the local development setup
- Start the ember app:
npm run ember
- Run the documentation site:
npm run storybook
(make sure thenpm run ember
command is finished) - Generate the icons:
npm run icons
We use the "template tag" (.gjs/.gts) format for component authoring which has been described in detail in the RFC. A summarized version can be found in the ember-template-imports library which also has some information about how to setup your dev environment for a better experience.
We're also converting the code to TypeScript and Glint.
Testing:
- the
/tests
route allows you to run the tests in your browser. - Specific ember-try scenarios can be run if you want to debug them locally:
npx ember try:one scenario-name
.--skip-cleanup
can be used to debug the scenario from the/tests
route - PR previews and testing is available on Chromatic
Testing changes in apps
npm link
- In the addon:
npm link
- In the your project:
npm link @appuniversum/ember-appuniversum
yalc
yalc is a good alternative if the npm link setup doesn't work as expected.
Releases:
Make sure all the merged PRs have the correct label, so they show up in the changelog
Release to npm: GITHUB_AUTH=your-token npm run release
and follow the prompts
License
This project is licensed under the MIT License.