Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scup/atellier
The smartest way to share interactive components with your team.
https://github.com/scup/atellier
Last synced: about 2 months ago
JSON representation
The smartest way to share interactive components with your team.
- Host: GitHub
- URL: https://github.com/scup/atellier
- Owner: scup
- License: mit
- Created: 2016-01-11T20:00:24.000Z (almost 9 years ago)
- Default Branch: development
- Last Pushed: 2016-09-05T21:01:31.000Z (over 8 years ago)
- Last Synced: 2024-09-19T21:17:13.265Z (3 months ago)
- Language: JavaScript
- Homepage: http://scup.github.io/atellier/
- Size: 8.86 MB
- Stars: 995
- Watchers: 27
- Forks: 33
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-react-components-all - react-atellier - The smartest way to share interactive components with your team. (Uncategorized / Uncategorized)
- awesome-list - react-atellier - The smartest way to share interactive components with your team. (Dev Tools / Miscellaneous)
- awesome-react-components - react-atellier - The smartest way to share interactive components with your team. (Dev Tools / Miscellaneous)
- jimsghstars - scup/atellier - The smartest way to share interactive components with your team. (JavaScript)
- awesome-react-components - react-atellier - The smartest way to share interactive components with your team. (Dev Tools / Miscellaneous)
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).