https://github.com/centerforopenscience/treebeard
Hierarchical grid implementation in Mithril
https://github.com/centerforopenscience/treebeard
Last synced: 6 months ago
JSON representation
Hierarchical grid implementation in Mithril
- Host: GitHub
- URL: https://github.com/centerforopenscience/treebeard
- Owner: CenterForOpenScience
- License: apache-2.0
- Created: 2014-09-29T14:28:39.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2017-11-30T20:02:41.000Z (about 8 years ago)
- Last Synced: 2024-04-14T05:19:04.651Z (almost 2 years ago)
- Language: JavaScript
- Homepage: http://centerforopenscience.github.io/treebeard/
- Size: 173 MB
- Stars: 27
- Watchers: 11
- Forks: 19
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Develop: 
Master: 
Logo designed by [fayetality](https://github.com/fayetality "fayetality")
treebeard
=========
Hierarchical data renderer built with Mithril
Using the library
-----------------
You can install Treebeard with bower. In your project simply run
```bower install treebeard --save```
Remember to reference the required files through bower_components.
You can also just take the files in `/dist` folder. You need the css and js files, either minified or in full and add them to your project page.
```html
```
### CommonJS
If you are using a CommonJS-compatible module loader (e.g. Webpack or Browserify), you can load treebeard like so:
```js
var Treebeard = require('treebeard');
```
**NOTE for Webpack users**: Loading Treebeard with Webpack will load its CSS as a module using the `style-loader` and `css-loader`. You should configure Webpack to use these loaders for `.css` files.
```
npm install style-loader css-loader --save
```
Add the following to your Webpack config.
```js
// webpack.config.js
// ...
module: {
loaders: [
{ test: /\.css$/, loader: 'style!css' },
],
},
```
* * *
Read more about using the library in the Wiki: https://github.com/CenterForOpenScience/treebeard/wiki
* * *
Installation for Developers
---------------------------
If you are a developer and want to work on the source code use the guide below.
Begin by cloning the project in any way that support your work flow, then go to the main project folder and run the following commands to install dependencies
For NPM:
npm install
for Bower
bower install
then run gulp like this
gulp
Gulp will be watching for changes in the CSS, LESS and JS files so any time you change the distribution folder will be automatically regenerated.
If you would like a simple server instance for this app you can install http-server
https://www.npmjs.org/package/http-server
Install with NPM:
npm install http-server