Skip to content

Commit

Permalink
small doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
dunnock committed Dec 3, 2016
1 parent 5491d0a commit 29f1f31
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
68 changes: 68 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# How to setup

## Folder Structure

```
react-sigma/
README.md
node_modules/
package.json
public/ -- static content
src/ -- sources
sigma-src/ -- interface to sigma library
types/ -- types for @flow checking
```

## Prerequisites

- node.js 4+
- npm

### `canvas`

Please note, distribution includes 'canvas-node' module suitable for running jsdom tests (sigma.js functionality). This package requires some global libraries dependencies to compile, please refer to [canvas installation](https://github.com/Automattic/node-canvas#installation) page for setup instructions.

### Enable flow type checking

Application is built with flow type checking embedded. But it requires flow-typed installed globally:

```
npm install -g flow-typed
flow-typed
```

## Available Scripts

In the project directory, you can run:

### `npm run storyboard`

Runs the app's storyboard with component visualizations.

The page will reload if you make edits.

### `npm test`

Launches the test runner in the interactive watch mode.
See the section about [running tests in create-react-app](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

### `npm run flow`

Performs flow type check, highly recommended before starting build.
Please note, all application custom types are stored in Component files (props and state descriptions) as well as under /types/ subdir.


# create-react-app regards

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

Below you will find some information on how to perform common tasks.
You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
2 changes: 1 addition & 1 deletion src/LoadGEXF.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Can be composed with other plugins: on load it mounts all child components (e.g.
Child's componentWillMount should be used to enable plugins on loaded graph.
Parameters:
- @path string path to the JSON file
- @path string path to the GEXF file
- @onGraphLoaded Function Optional callback for graph update
[see sigma plugin page for more details](https://github.com/jacomyal/sigma.js/tree/master/plugins/sigma.neo4j.cypher)
Expand Down
2 changes: 2 additions & 0 deletions src/RelativeSize.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ It supposes that sigma graph is already in place, therefore component should not
mounted until graph is available. It can be used within Sigma component if graph is
preloaded, or within loader component, like NeoCypher.
Sets nodes sizes corresponding its degree.
Parameters:
- @initialSize number start size for every node, will be multiplied by Math.sqrt(node.degree)
Expand Down

0 comments on commit 29f1f31

Please sign in to comment.