Zhihe Li
fa18bfff01
This commit has a few notable changes: 1. A simple attempt at establishing a pattern for using SELECT statements. This will be useful in the future for joins/subquery support. 2. Expanded usage of searching to be able to pass instead of just a string, an object that lets a consumer choose which columns to search on. 3. Decouple our session recording filters from being loaded from the route model hook which is a departure from our convention. This has the benefit of actually letting the page first load and having the filters load async so the page doesn't wait for the filters to finish. This is also much faster to query for each individual filter option from SQLite rather than returning all data to filter in application code.
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
- Pnpm 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": "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'
}
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.
Pnpm Commands
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.
Linting
pnpm lint:fixpnpm lint:hbspnpm lint:hbs:fixpnpm lint:jspnpm lint:js:fix
Formatting
Before submitting your work, be sure to run auto-formatters (see commands above). This helps to ensure consistency among authors.
pnpm format
Running tests
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
Running the dummy application
pnpm 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 pnpm doc:toc. Please update the ToC whenever editing the structure
of README.