-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
21 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,16 @@ | ||
# Reports | ||
|
||
This repository contains a template for [interuss/monitoring/uss_qualifier](https://github.com/interuss/monitoring/blob/main/monitoring/uss_qualifier) reports. | ||
|
||
The report must be bundled as a single file to include all dependencies and allow users to download and open it on their machine without experiencing [CORS issues](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSRequestNotHttp) without requiring starting a local server.. | ||
|
||
See [reports](./reports) for getting started. | ||
|
||
|
||
## Release | ||
|
||
To release a new version of the report, create a new tag by creating a new release on this [page](https://github.com/Orbitalize/reports/releases). | ||
This will trigger the [release workflow](./.github/workflows/release.yaml) which will generate a single file bundle of the report application and publish it as a zip. | ||
|
||
The zip file can then be used as an report template in the [interuss/monitoring](https://github.com/interuss/monitoring/blob/main/monitoring/uss_qualifier/configurations/configuration.py#L49) report configuration. See [U-Space test suite](https://github.com/interuss/monitoring/blob/main/monitoring/uss_qualifier/configurations/dev/uspace.yaml#L32) as example. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,11 @@ | ||
# React + TypeScript + Vite | ||
# Reports: single bundle web application | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
This project uses typescript, React and vitejs to generate a modern single bundle application. | ||
|
||
Currently, two official plugins are available: | ||
## Available commands | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
Start development server (including hot refresh): yarn start | ||
Generate bundle: yarn build | ||
|
||
## Expanding the ESLint configuration | ||
Use to list the available commands: yarn run -l | ||
|
||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
|
||
```js | ||
parserOptions: { | ||
ecmaVersion: 'latest', | ||
sourceType: 'module', | ||
project: ['./tsconfig.json', './tsconfig.node.json'], | ||
tsconfigRootDir: __dirname, | ||
}, | ||
``` | ||
|
||
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` | ||
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` | ||
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list |