generated from finos-labs/project-blueprint
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into renovate/react-json-view-lite-2.x-lockfile
- Loading branch information
Showing
16 changed files
with
30,423 additions
and
27,042 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
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
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: Build CALM Visualizer | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - "main" | ||
| paths: | ||
| - "calm-visualizer/**" | ||
| push: | ||
| branches: | ||
| - "main" | ||
| paths: | ||
| - "calm-visualizer/**" | ||
|
|
||
| jobs: | ||
| shared: | ||
| name: Build, Test, and Lint Shared Module | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout PR Branch | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: v20 | ||
|
|
||
| - name: Install workspace | ||
| run: npm ci | ||
|
|
||
| - name: Lint Shared Module | ||
| run: npm run lint --workspace=calm-visualizer | ||
|
|
||
| - name: Build workspace | ||
| run: npm run build --workspace=calm-visualizer | ||
|
|
||
| - name: Run tests for Shared | ||
| run: npm run test --workspace=calm-visualizer |
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
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,50 +1,45 @@ | ||
| # React + TypeScript + Vite | ||
| ## Calm Visualizer | ||
|
|
||
| This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
| Calm Visualizer is a tool designed to help visualize and manage software architecture through a UI. | ||
|
|
||
| Currently, two official plugins are available: | ||
| ### Features | ||
|
|
||
| - [@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 | ||
| - Visualize uploaded architecure JSON file using cytoscape JS | ||
| - Toggle connection and node descriptions | ||
|
|
||
| ## Expanding the ESLint configuration | ||
| ### Installation | ||
|
|
||
| If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
| To install Calm Visualizer, clone the repository and install the dependencies: | ||
|
|
||
| - Configure the top-level `parserOptions` property like this: | ||
| ```sh | ||
| cd calm-visualizer | ||
| npm install | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| To start the UI, run: | ||
|
|
||
| ```js | ||
| export default tseslint.config({ | ||
| languageOptions: { | ||
| // other options... | ||
| parserOptions: { | ||
| project: ['./tsconfig.node.json', './tsconfig.app.json'], | ||
| tsconfigRootDir: import.meta.dirname, | ||
| }, | ||
| }, | ||
| }); | ||
| ```sh | ||
| npm run dev | ||
| ``` | ||
|
|
||
| - Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` | ||
| - Optionally add `...tseslint.configs.stylisticTypeChecked` | ||
| - Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: | ||
|
|
||
| ```js | ||
| // eslint.config.js | ||
| import react from 'eslint-plugin-react'; | ||
|
|
||
| export default tseslint.config({ | ||
| // Set the react version | ||
| settings: { react: { version: '18.3' } }, | ||
| plugins: { | ||
| // Add the react plugin | ||
| react, | ||
| }, | ||
| rules: { | ||
| // other rules... | ||
| // Enable its recommended rules | ||
| ...react.configs.recommended.rules, | ||
| ...react.configs['jsx-runtime'].rules, | ||
| }, | ||
| }); | ||
| This will start the UI and you can access the application at `http://localhost:5174`. | ||
|
|
||
| ### Building for Production | ||
|
|
||
| To build the application for production, run: | ||
|
|
||
| ```sh | ||
| npm run build | ||
| ``` | ||
|
|
||
| This will create a `dist` directory with the production build of the application. | ||
|
|
||
| ## License | ||
|
|
||
| Copyright 2024 FINOS | ||
|
|
||
| Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). | ||
|
|
||
| SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0) |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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 |
|---|---|---|
|
|
@@ -40,7 +40,3 @@ | |
| margin-top: 10px; | ||
| color: black; | ||
| } | ||
|
|
||
| .relationship-label { | ||
| background-color: white; | ||
| } | ||
Oops, something went wrong.