# react-atellier
> The smartest way to share interactive components with your team
Latest version **0.1.13** (published 2016-09-05) · MIT license · 0 weekly downloads
## Install
```sh
npm install react-atellier
pnpm add react-atellier
yarn add react-atellier
bun add react-atellier
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.1.13 |
| Published | 2016-09-05 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 990 |
| Author | Scup/Sprinklr Team |
| Maintainers | scup |
| Keywords | react, reactjs, react-component, component, components, emulator, preview, atellier, atelier, attelier |
## Links
- npm: https://www.npmjs.com/package/react-atellier
- Repository: https://github.com/scup/atellier
- Homepage: https://github.com/scup/atellier#readme
- Issues: https://github.com/scup/atellier/issues
- npm.io page: https://npm.io/package/react-atellier
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 0.1.13 (latest) — 2016-09-05
- 0.1.12 — 2016-09-05
- 0.1.11 — 2016-08-31
- 0.1.10 — 2016-04-04
- 0.1.9 — 2016-04-01
- 0.1.8 — 2016-04-01
- 0.1.7 — 2016-04-01
- 0.1.6 — 2016-04-01
- 0.1.5 — 2016-04-01
- 0.1.3 — 2016-04-01
- 0.1.2 — 2016-04-01
- 0.1.1 — 2016-04-01
- 0.1.0 — 2016-04-01
- 0.0.14 — 2016-02-15
- 0.0.13 — 2016-02-15
- … 11 more at https://npm.io/package/react-atellier/versions
## README
# 
[](https://gitter.im/scup/atellier?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://david-dm.org/scup/Atellier)
[](https://travis-ci.org/scup/atellier)
[](https://codeclimate.com/github/scup/Atellier)
[](https://badge.fury.io/js/react-atellier)
[](http://developers.scup.com)
[](https://gitter.im/scup/atellier?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A React component that works like a preview of other components. An excellent tool to show how your component works and looks with. Easy to install and configure, you can have a router in your project with Atellier and can interact with any component.
Imagine a universe in which you may have tools (***components***) tested in real time! This is amazing!
## Online Demos
* [Atellier and Material UI](http://scup.github.io/atellier/material-ui-atellier/)
## Install
```shell
npm install -g react-atellier
```
## Usage
**Import Atellier**
For releases: `> v0.1.0` (NEWER)
```javascript
...
import ReactAtellier from 'react-atellier';
```
For releases: `<= v0.0.14`
```javascript
...
var ReactAtellier = require('react-atellier')( React );
```
**Import your component**
```javascript
import myComponent from 'myComponent';
const componentList = [{
componentName : myComponent.displayName,
component : myComponent
}];
```
**OR your component library**
```javascript
import myComponents from 'myComponent';
const componentList = myComponents.map( (comp)=> {
return {
componentName : comp.displayName,
component : comp
}
})
```
**pass your components to Atellier over components prop.**
```javascript
var AtellierWrapper = React.createClass({
render: function() {
return (
);
}
});
```
**and then you need to render the Atellier somewhere in your application.**
```javascript
render((
), document.body)
```
---
## Todo
- [ ] Atellier CLI (wip)
- [ ] Import components and live update
- [ ] Move components in `stage`
## Team
- [Guilherme de Souza](https://github.com/guisouza)
- [Alberto](https://github.com/albertossilva)
- [Érica Mitsuishi](https://github.com/mitsuishihidemi)
- [Bruno Agutoli](https://github.com/agutoli)
- [Daniel Allegretti](https://github.com/allegretti)
- [João Neto](https://github.com/joaoneto)
- [Geison](https://github.com/ogeison)
# Contributors
- [John Babak](https://github.com/sompylasar)
## Contribute
Come with us to make an awesome *Atellier* tool to run components in live ambient.
Now, if you do not have technical knowledge and also have intend to help us, do not feel shy, [click here](https://github.com/scup/Atellier/issues) to open an issue and collaborate their ideas, the contribution may be a criticism or a compliment (why not?)
We have some conventions to contribute to the *Atellier* project, see more information in our [CONTRIBUTING.md](CONTRIBUTING.md). So please, read this before send to us a [pull requests](https://github.com/scup/Atellier/pulls).
## Want help?
- [issues](https://github.com/scup/Atellier/issues)
- ~~IRC #react-atellier on [freenode](https://freenode.net/)~~
- [Gitter](https://gitter.im/scup/atellier?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
## License
**React Atellier** is released under the
[MIT license](https://github.com/scup/atellier/blob/development/LICENSE.md).
---
_Source: https://npm.io/package/react-atellier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._