Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
vria - npm Package Compare versions
Comparing version 0.9.1 to 0.9.2
| { | ||
| "name": "vria", | ||
| "version": "0.9.1", | ||
| "version": "0.9.2", | ||
| "description": "A Web-based Framework for Creating Immersive Analytics Experiences", | ||
@@ -26,3 +26,3 @@ "author": "PButcher", | ||
| "predeploy": "cd builder && yarn install && yarn run build", | ||
| "deploy": "gh-pages -d builder/build" | ||
| "deploy": "./node_modules/gh-pages/bin/gh-pages-clean.js && gh-pages -d builder/dist" | ||
| }, | ||
@@ -29,0 +29,0 @@ "peerDependencies": { |
110
README.md
|  | ||
| <p style="text-align: center"> | ||
| <img width="200" height="82" src="https://pbutcher.uk/files/vria/img/vria-github-logo.png"> | ||
| </p> | ||
| <p style="text-align: center;"> | ||
| <strong>VRIA</strong><br> | ||
| <span>A Web-Based Framework for Creating Immersive Analytics Experiences</span> | ||
| </p> | ||
| --- | ||
| <img align="right" width="200" height="82" src="https://pbutcher.uk/files/vria/img/vria-github-logo.png"> | ||
| # VRIA | ||
| [](https://www.npmjs.com/package/vria) | ||
| [](https://www.npmjs.com/package/vria) [](https://github.com/vriajs/vria/blob/master/LICENSE) | ||
@@ -28,3 +22,3 @@ A Web-Based Framework for Creating Immersive Analytics Experiences | ||
| - [VRIA `aframe-react` Component and API](#vria-aframe-react-component-and-api) | ||
| - [Props Reference](#props-reference) | ||
| - [Props API Reference](#props-api-reference) | ||
| - [config](#config) | ||
@@ -39,6 +33,8 @@ - [onConfigParsed](#onconfigparsed) | ||
| - [options](#options) | ||
| - [Config Validation](#config-validation) | ||
| - [VRIA Builder](#vria-builder) | ||
| - [VRIA Boilerplate](#vria-boilerplate) | ||
| - [Team](#team) | ||
| - [Citing VRIA](#citing-vria) | ||
| - [Publications](#publications) | ||
| - [Citation](#citation) | ||
| - [License](#license) | ||
@@ -72,13 +68,16 @@ | ||
| To add VRIA to a new or existing project you will need [NodeJS](https://nodejs.org) (>= v10.0). You will also need to install [`react`](https://npmjs.org/package/react) and [`react-dom`](https://npmjs.org/package/react-dom) if you haven't already. The easiest way to get started with a new React project is via [create-react-app](https://create-react-app.dev/docs/getting-started/) _(recommended)_. | ||
| To add VRIA to a new or existing project you will need: | ||
| Alternatively, you can add React later and start off by installing VRIA on its own and using the `boilerplate/` directory to create your first VRIA app. [[docs](#vria-boilerplate)] | ||
| - [NodeJS](https://nodejs.org) (>= v10.0). | ||
| - You will also need to install [`react`](https://npmjs.org/package/react) and [`react-dom`](https://npmjs.org/package/react-dom) if you haven't already. The easiest way to get started with a new React project is via [create-react-app](https://create-react-app.dev/docs/getting-started/) _(recommended)_. | ||
| - Alternatively, you can add React later and start off by installing VRIA on its own by cloning this repository and using the `boilerplate/` directory to create your first VRIA app [[docs](#vria-boilerplate)]. The VRIA Builder is also available to install locally in the `builder/` directory [[docs](#vria-builder)]. | ||
| - Finally, you will need to include the A-Frame library script in the `<head>` of your `index.html` file: | ||
| The VRIA builder is also available to install locally in the `builder/` directory. [[docs](#vria-builder)] | ||
| ```html | ||
| <script src="https://aframe.io/releases/1.0.4/aframe.min.js"></script> | ||
| ``` | ||
| Whichever route you choose to take, these next steps remain the same. | ||
| ### Installing VRIA | ||
| You can install VRIA with [Yarn](https://yarnpkg.com) or [NPM](https://npmjs.org): | ||
| You can add VRIA to a new or existing application by installing it with [Yarn](https://yarnpkg.com) or [NPM](https://npmjs.org): | ||
@@ -95,10 +94,10 @@ ```bash | ||
| This will add VRIA to your `package.json` file. | ||
| You can then include VRIA in your project: | ||
| If you cloned this repository instead, you can install VRIA by running either `yarn install` or `npm install`. | ||
| ```jsx | ||
| import VRIA from 'vria'; | ||
| ``` | ||
| Next you will need to start the development server. | ||
| ### Run the development server | ||
| ### Run development server | ||
| If you are using `create-react-app` you can run either `yarn start` or `npm start` to start the development server. | ||
@@ -144,3 +143,3 @@ | ||
| You can build your app for production to the `build/` directory by running either `yarn run build` or `npm run build`. | ||
| You can build your app for production to the `build/` directory by running either `yarn build` or `npm run build`. | ||
@@ -177,3 +176,3 @@ --- | ||
| ### Props Reference | ||
| ### Props API Reference | ||
@@ -209,2 +208,13 @@ - [config](#config) | ||
| Example usage: | ||
| ```jsx | ||
| <VRIA | ||
| config={config} | ||
| onConfigParsed={({ compiledConfig, dataset, domainMap, scales }) => { | ||
| // Do something once the vis-config is compiled | ||
| }} | ||
| /> | ||
| ``` | ||
| #### `additionalFilters` | ||
@@ -256,2 +266,8 @@ | ||
| | Argument | Type | Description | | ||
| | ----------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | ||
| | `domainMap` | [_Map()_](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) | Current state of visualization filters by field=>domain. | | ||
| Example usage: | ||
| ```jsx | ||
@@ -334,3 +350,3 @@ <VRIA | ||
| ```jsx | ||
| <VRIA config={config} customMarks={{ customMark }} /> | ||
| <VRIA config={config} customMarks={{ customMark, otherCustomMark }} /> | ||
| ``` | ||
@@ -364,2 +380,18 @@ | ||
| ### Config validation | ||
| Although VRIA will validate your vis-config at runtime, sometimes you may wish to valid a VRIA vis-config against the VRIA JSON Schema before passing it to VRIA. To do this you can run it through the validator with the `validateVisConfig` named export: | ||
| ```jsx | ||
| import { validateVisConfig, schema } from 'vria'; | ||
| import config from './config'; | ||
| // Validate a vis-config | ||
| console.log(validateVisConfig(config)); | ||
| ``` | ||
| This example also shows you how to access the VRIA JSON Schema if you wish to do your own validation. | ||
| --- | ||
| ## VRIA Builder | ||
@@ -371,8 +403,13 @@ | ||
| 1. Navigate to `builder/` | ||
| 2. Run `yarn install` or `npm install` | ||
| 3. Run `yarn start` or `npm start` | ||
| 1. Clone or fork the VRIA Git repository | ||
| 2. Navigate to `builder/` | ||
| 3. Run `yarn install` or `npm install` | ||
| 4. Run `yarn start` or `npm start` | ||
| The builder is now running at `localhost:3000` | ||
| Run `yarn build` or `npm run build` to create a production ready build of the VRIA builder to `builder/build`. | ||
| --- | ||
| ## VRIA Boilerplate | ||
@@ -382,8 +419,13 @@ | ||
| 1. Navigate to `boilerplate/` | ||
| 2. Run `yarn install` or `npm install` | ||
| 3. Run `yarn start` or `npm start` | ||
| 1. Clone or fork the VRIA Git repository | ||
| 2. Navigate to `boilerplate/` | ||
| 3. Run `yarn install` or `npm install` | ||
| 4. Run `yarn start` or `npm start` | ||
| The boilerplate example is now running at `localhost:3000` | ||
| Run `yarn build` or `npm run build` to create a production ready build of your app to `boilerplate/build`. | ||
| --- | ||
| ## Team | ||
@@ -393,2 +435,4 @@ | ||
| --- | ||
| ## Publications | ||
@@ -402,3 +446,3 @@ | ||
| ## Citing VRIA | ||
| ### Citation | ||
@@ -417,4 +461,6 @@ ```bib | ||
| --- | ||
| ## License | ||
| MIT © Copyright 2020 [Peter W. S. Butcher](https://twitter.com/pwsbutcher), [Nigel W. John](https://twitter.com/nigeljohn12) and [Panagiotis D. Ritsos](https://twitter.com/ritsos_p) - University of Chester, UK (Visualization, Interaction and Graphics Research Group) and Bangor University, UK (Visualization, Modeling and Graphics Research Group) - All rights reserved |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.36%
491060
- Number of lines in readme file
- increased by11.33%
452
No dependency changes