In api and rose addons, ember-data-fragments and ember-modifier packages need to be installed before addon usage to avoid errors.
API data layer Ember Addon for Boundary
This addon contains the API data access layer for Boundary.
Table of Contents generated with DocToc
- Add API to an App
- Installation
- Yarn Commands
- Linting
- Formatting
- Running tests
- Running the dummy application
- Contributing
Add API to an App
Add this addon to an Ember application's devDependencies as:
"api": "*", for applications included in this monorepo.
Installation
See monorepo README for installation instructions.
When manually installing addon, ensure ember-data-fragments@5.0.0-beta.* is installed to use api models with data fragments.
Yarn Commands
List of available project commands. yarn run <command-name>
| Command | Description |
|---|---|
| build:development | Builds the dummy app in development mode. |
| build | Builds the dummy app for production. |
| lint | Runs all lint commands. |
| lint:js | Lints js files. |
| format | Runs all auto-formatters. |
| format:js | Auto-formats js files using Prettier. |
| start | Runs the dummy app local server. |
| test | Runs all tests. |
| test:all | Runs tests across multiple Ember versions with ember-try. |
| doc:toc | Automatically generates a table of contents for this README file. |
Additional commands in the monorepo package may affect this projects.
Linting
yarn lint:hbsyarn lint:jsyarn lint:js --fix
Formatting
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
yarn format
Running tests
yarn test– Runs the test suite on the current Ember versionyarn test --server– Runs the test suite in "watch mode"yarn test:all– Runs the test suite against multiple Ember versions
Running the dummy application
yarn start- Visit the dummy application at http://localhost:4200.
Contributing
See monorepo README for more contribution instructions.
Building ToC
To autogenerate a ToC (table of contents) for this README,
run yarn doc:toc. Please update the ToC whenever editing the structure
of README.