This addon contains the API data access layer for Boundary.
Table of Contents generated with DocToc
- Add API to an App
- Installation
- Pnpm Commands
- Linting
- Formatting
- Running tests
- Running the dummy application
- Contributing
Add this addon to an Ember application's devDependencies
as:
"api": "workspace:*"
, for applications included in this monorepo.
Since this addon also includes Mirage mocks, be sure to install
ember-cli-mirage
and add the following config to your UI project:
'ember-cli-mirage': {
directory: '../../addons/api/mirage'
}
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.
List of available project commands. pnpm 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:fix | Runs automatic lint fixes for all type of file. |
lint:hbs | Runs lint for hbs template files. |
lint:hbs:fix | Runs automatic lint fixes for hbs template files. |
lint:js | Lints js files. |
lint:js:fix | Runs automatic lint fixes for 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:ember-compatibility | Runs tests across multiple Ember versions with ember-try. |
precommit | Runs all lint and format. |
doc:toc | Automatically generates a table of contents for this README file. |
Additional commands in the monorepo package may affect this projects.
pnpm lint:fix
pnpm lint:hbs
pnpm lint:hbs:fix
pnpm lint:js
pnpm lint:js:fix
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
pnpm format
pnpm test
β Runs the test suite on the current Ember versionpnpm test --server
β Runs the test suite in "watch mode"pnpm test:all
β Runs the test suite against multiple Ember versions
pnpm start
- Visit the dummy application at http://localhost:4200.
See monorepo README for more contribution instructions.
To autogenerate a ToC (table of contents) for this README,
run pnpm doc:toc
. Please update the ToC whenever editing the structure
of README.