jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 17:58:43 -05:00
Code Issues Projects Releases Wiki Activity

docs: visualize packages (#952)

Browse Source
This commit is contained in:
Li Kang
2022-10-06 13:26:44 +02:00
committed by GitHub
parent 3b885ed584
commit eda03ccb23
2 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
.github/CONTRIBUTING.md vendored
View File

@@ -19,7 +19,7 @@ Bugs can be reported by filing a [new bug issue](https://github.com/qlik-oss/neb
## <a name="features"></a> Proposing a change ## <a name="features"></a> Proposing a change
If you want to propose changes to this project, let us know by [filing a issue](https://github.com/qlik-oss/nebula.js/issues/new/choose). If you want to propose changes to this project, let us know by [filing an issue](https://github.com/qlik-oss/nebula.js/issues/new/choose).
If the proposal includes new designs or bigger changes, please be prepared to discuss the changes with us so we can cooperate on how to best include them. If the proposal includes new designs or bigger changes, please be prepared to discuss the changes with us so we can cooperate on how to best include them.
@@ -37,7 +37,7 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
- `nucleus`: JavaScript library for mashups - `nucleus`: JavaScript library for mashups
- `supernova`: JavaScript API for consuming and visualizing QIX data - `supernova`: JavaScript API for consuming and visualizing QIX data
- `stardust`: Public JavaScript API which exposes the nucleus and supernova APIs - `stardust`: Public JavaScript API which exposes the nucleus and supernova APIs
- `enigma-mocker`: Public JavaScript API which creates a mocked enigma app to renders visualizations without a connected Qlik engine - `enigma-mocker`: Public JavaScript API which creates a mocked enigma app to render visualizations without a connected Qlik engine
- `snapshooter`: Public JavaScript API which captures rendered charts as images - `snapshooter`: Public JavaScript API which captures rendered charts as images
- `conversion`: [private] Provides conversion functionality to extensions with hyperCubes. - `conversion`: [private] Provides conversion functionality to extensions with hyperCubes.
- `theme`: [private] Provides access and consumption of the currently applied theme - `theme`: [private] Provides access and consumption of the currently applied theme
@@ -45,13 +45,21 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
- `commands` - CLI commands - `commands` - CLI commands
- `build`: cli command to build a supernova - `build`: cli command to build a supernova
- `cli`: entry point for all cli commands - `cli`: entry point for all cli commands
- `create`: cli command for creating a supernova project - `create`: CLI command for creating a supernova project
- `sense`: cli command to build a Qlik Sense extension from a supernova - `sense`: CLI command to build a Qlik Sense extension from a supernova
- `serve`: cli command to start a development server for rapid prototyping of a supernova - `serve`: CLI command to start a development server for rapid prototyping of a supernova
- `packages` - `packages`
- `ui`: [private] ui components - `ui`: [private] UI components
- `test/`: contains test configs - `test/`: contains test configs
### Visualizing packages
To better understand packages' relations, you can use Nx's capabilities to open an interactive visualization of the package graph.
To open the visualization, run:
npx nx graph
### Development workflow ### Development workflow
- `yarn` install all dependencies - `yarn` install all dependencies
@@ -106,7 +114,7 @@ Generally, development should be done directly towards the `master` branch.
> Before creating a Pull Request, make sure to sign the [CLA](#cla) > Before creating a Pull Request, make sure to sign the [CLA](#cla)
In the Github UI of your fork, create a Pull Request to the `master` branch of the master repository. In the GitHub UI of your fork, create a Pull Request to the `master` branch of the master repository.
If the branch has merge conflicts or has been outdated, please do a rebase against the `master` branch. If the branch has merge conflicts or has been outdated, please do a rebase against the `master` branch.
@@ -127,7 +135,7 @@ Should be one of the following:
- **perf:** A code change that improves performance - **perf:** A code change that improves performance
- **refactor:** Changes to production code that is neither a new feature nor a bug fix - **refactor:** Changes to production code that is neither a new feature nor a bug fix
- **revert:** Reverts a previous commit - **revert:** Reverts a previous commit
- **style:** Changes to code style formatting (white space, commas etc) - **style:** Changes to code style formatting (white space, commas, etc)
- **test:** Changes in test cases of production code - **test:** Changes in test cases of production code
#### Scope #### Scope

8
commands/cli/README.md
View File

@@ -46,10 +46,10 @@ Open up your package.json, those dependencies are added.
```json ```json
{ {
"devDependencies": { "devDependencies": {
"@nebula.js/cli": "1.7.0", "@nebula.js/cli": "latest",
"@nebula.js/cli-build": "1.7.0", "@nebula.js/cli-build": "latest",
"@nebula.js/cli-sense": "1.7.0", "@nebula.js/cli-sense": "latest",
"@nebula.js/cli-serve": "1.7.0" "@nebula.js/cli-serve": "latest"
} }
} }
``` ```