-
Notifications
You must be signed in to change notification settings - Fork 1
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
1 parent
f1b169a
commit 3283605
Showing
1 changed file
with
11 additions
and
66 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,76 +1,21 @@ | ||
| # RevealSdkWrappers | ||
| # Reveal Sdk Wrappers | ||
|
|
||
| <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> | ||
| Welcome to the Reveal SDK Web Components documentation! This project is a community-driven initiative focused on modernizing and enhancing the [Reveal SDK](https://www.revealbi.io/). At its core, the Reveal SDK Web Components provide a streamlined web component wrapper around the existing jQuery-based `RevealView` component, simplifying the integration and use of the Reveal SDK in modern web applications. | ||
|
|
||
| ✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ | ||
| ## What Are Reveal SDK Web Component Wrappers? | ||
|
|
||
| ## Integrate with editors | ||
| The Reveal SDK Web Component Wrappers are essentially web components that wrap the existing `RevealView`, a jQuery-based component that powers the core data visualization features of the Reveal SDK. By encapsulating the complex functionalities of `RevealView` into modern web components, we provide a more intuitive and developer-friendly way to integrate Reveal's powerful capabilities into your projects. These web components abstract away the underlying jQuery implementation, allowing you to work with Reveal in a more modern and efficient way. | ||
|
|
||
| Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console | ||
| provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and | ||
| comes with a LSP for Vim users. | ||
| ## Why Use Reveal SDK Web Components? | ||
|
|
||
| ## Nx plugins and code generators | ||
| In today's fast-paced web development environment, simplicity, ease of integration, and adaptability are crucial. The Reveal SDK Web Components project addresses these needs by wrapping the existing jQuery-based functionality in modern web components, offering several key benefits: | ||
|
|
||
| Add Nx plugins to leverage their code generators and automated, inferred tasks. | ||
| 1. **Enhanced Usability**: With Reveal SDK Web Components, we simplify how you interact with the Reveal SDK. Rather than working directly with the jQuery-based `RevealView`, these web components offer a more accessible API. You can now integrate complex data visualization elements using straightforward HTML tags, reducing both the learning curve and development time. | ||
|
|
||
| ``` | ||
| # Add plugin | ||
| npx nx add @nx/react | ||
| 2. **Seamless Integration with Frameworks**: Reveal SDK Web Components are designed to work effortlessly with popular JavaScript frameworks like Angular, React, and Vue. The web component wrappers ensure that the underlying `RevealView` can be integrated into these frameworks without compatibility issues, allowing you to fully leverage Reveal’s features within your preferred development environment. | ||
|
|
||
| # Use code generator | ||
| npx nx generate @nx/react:app demo | ||
| 3. **Continuous Improvement**: As part of our commitment to continuous improvement, we actively refine these web components and the underlying Reveal APIs based on community and customer feedback. This ensures that you always have access to the latest features and enhancements, helping you stay ahead in delivering powerful and responsive data visualizations. | ||
|
|
||
| # Run development server | ||
| npx nx serve demo | ||
| ## Conclusion | ||
|
|
||
| # View project details | ||
| npx nx show project demo --web | ||
| ``` | ||
|
|
||
| Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list <plugin-name>` to see what generators are available. | ||
|
|
||
| Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs. | ||
|
|
||
| ## Running tasks | ||
|
|
||
| To execute tasks with Nx use the following syntax: | ||
|
|
||
| ``` | ||
| npx nx <target> <project> <...options> | ||
| ``` | ||
|
|
||
| You can also run multiple targets: | ||
|
|
||
| ``` | ||
| npx nx run-many -t <target1> <target2> | ||
| ``` | ||
|
|
||
| ..or add `-p` to filter specific projects | ||
|
|
||
| ``` | ||
| npx nx run-many -t <target1> <target2> -p <proj1> <proj2> | ||
| ``` | ||
|
|
||
| Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks). | ||
|
|
||
| ## Set up CI! | ||
|
|
||
| Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. | ||
|
|
||
| - [Set up remote caching](https://nx.dev/features/share-your-cache) | ||
| - [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) | ||
| - [Learn more how to setup CI](https://nx.dev/recipes/ci) | ||
|
|
||
| ## Explore the project graph | ||
|
|
||
| Run `npx nx graph` to show the graph of the workspace. | ||
| It will show tasks that you can run with Nx. | ||
|
|
||
| - [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) | ||
|
|
||
| ## Connect with us! | ||
|
|
||
| - [Join the community](https://nx.dev/community) | ||
| - [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) | ||
| - [Follow us on Twitter](https://twitter.com/nxdevtools) | ||
| By using the Reveal SDK Web Component Wrappers, you benefit from the powerful capabilities of the jQuery-based `RevealView` component, but in a more modern, efficient, and developer-friendly package. These web component wrappers allow you to focus on building sophisticated data visualizations without needing to manage the complexity of the underlying framework. Start exploring today and see how easy it is to bring your data to life! |