Use SourceJS for describing separate UI components

[robhrt7]

Currently SourceJS expects to have a basic set-up with custom configured user folder. This is great for building collaborative component libraries and Style Guides, but is a bit complicated for defining stand-alone component (or bundle) documentation.

Example usecase:
Developer creates a React Component to be shared with the open source community. In his team, he could add this component to common SourceJS set-up. But for those, who don't have this common SourceJS set-up, this component documentation won't be available.

Any SourceJS compliant component should have an easy way of running visual documentation environment with few commands.

Intended workflow:

git clone <stand-alone-component> && cd stand-alone-component
sourcejs run [or npm start]
open http://localhost:8080

This feature will require an ability to install SourceJS as npm dependency, and use only default settings, without relying on any configuration. Preferably to have SourceJS CLI #144.

If SourceJS will always require some basic set-up, we can create a basic Gulp initialization plugin, which will prepare all default configs and run the engine.

[ndelangen]

I think this is now how 0.6 actually works, or am I forgetting something? Can we close this one?

[robhrt7]

It's almost is, but I'll need to re-test it and do a small demo project to be sure the DX is good enough.

[ndelangen]

It has been for me 👍