https://github.com/folkloreinc/panneau-js

React components to build forms and administration panels
https://github.com/folkloreinc/panneau-js

Last synced: about 2 months ago
JSON representation

React components to build forms and administration panels

• Host: GitHub
• URL: https://github.com/folkloreinc/panneau-js
• Owner: folkloreinc
• Created: 2017-08-15T18:51:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T16:54:40.000Z (3 months ago)
• Last Synced: 2024-10-29T22:32:09.037Z (2 months ago)
• Language: JavaScript
• Homepage: https://folkloreinc.github.io/panneau-js/
• Size: 70.3 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
Panneau

============

[![Build Status](https://travis-ci.org/Folkloreatelier/panneau-js.svg?branch=master)](https://travis-ci.org/Folkloreatelier/panneau-js)

[![Coverage Status](https://coveralls.io/repos/github/Folkloreatelier/panneau-js/badge.svg?branch=master)](https://coveralls.io/github/Folkloreatelier/panneau-js?branch=master)

## Installation

```

npm install panneau --save

```

## Packages

This package is splitted in multiple packages that can be used independently.

### Core

| Package Name | Description | Links |

| ------------ | ----------- | ----- |

| [panneau](https://github.com/folkloreinc/panneau-js/tree/master/packages/panneau) | Main package |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/packages/panneau/) |

| [@panneau/core](https://github.com/folkloreinc/panneau-js/tree/master/packages/core) | Core utilities |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/packages/core/) |

### Fields

| Package Name | Description | Links |

| ------------ | ----------- | ----- |

| [@panneau/fields](https://github.com/folkloreinc/panneau-js/tree/master/fields/fields) | Collection of fields |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/fields/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=FieldsGroup&selectedStory=simple) |

| [@panneau/field-code](https://github.com/folkloreinc/panneau-js/tree/master/fields/code) | Code editor |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/code/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FCode&selectedStory=simple) |

| [@panneau/field-color](https://github.com/folkloreinc/panneau-js/tree/master/fields/color) | Color picker |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/color/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FColor&selectedStory=simple) |

| [@panneau/field-date](https://github.com/folkloreinc/panneau-js/tree/master/fields/date) | Date picker |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/date/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FDate&selectedStory=simple) |

| [@panneau/field-select](https://github.com/folkloreinc/panneau-js/tree/master/fields/select) | Select field (supports AJAX and multiple choices) |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/select/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FSelect&selectedStory=simple) |

| [@panneau/field-slider](https://github.com/folkloreinc/panneau-js/tree/master/fields/slider) | Slider (supports range) |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/slider/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FSlider&selectedStory=simple) |

| [@panneau/field-text](https://github.com/folkloreinc/panneau-js/tree/master/fields/text) | Input text or HTML Editor (CKEditor) |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/text/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FText&selectedStory=simple) |

| [@panneau/field-toggle](https://github.com/folkloreinc/panneau-js/tree/master/fields/toggle) | Toggle field |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/fields/toggle/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Fields%2FToggle&selectedStory=simple) |

### Modals

| Package Name | Description | Links |

| ------------ | ----------- | ----- |

| [@panneau/modal-popover](https://github.com/folkloreinc/panneau-js/tree/master/modals/popover) | Popover |  [Documentation](https://github.com/folkloreinc/panneau-js/tree/master/modals/popover/) - [Examples](https://folkloreatelier.github.io/panneau-js/?selectedKind=Modals%2FPopover&selectedStory=simple) |

## Development

### Installation

1. If you don't have lerna, you should install it globally:

```bash

npm install -g lerna

```

2. Install all dependencies:

```bash

lerna bootstrap

```

#### Note

Do not use npm directly to install the dependencies. Since the repository is managed by Lerna, to avoir conflicts, it's best to use the `bootstrap` command to let it install everything.

In case you have problems with dependencies, you can always clean every node_modules folder with these commands:

```bash

rm -rf node_modules

lerna clean

```