-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from myheritage/develop
renaming to UiZoo.js to master
- Loading branch information
Showing
58 changed files
with
238 additions
and
245 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
web: ./node_modules/.bin/rollup -c rollup-build.config.js -o dist/index.js -f iife -n Bibliotheca -g underscore:_,react:React,react-dom:ReactDOM,react-router-dom:ReactRouterDOM,doctrine:doctrine-standalone,babel-standalone:Babel && node server/main.js | ||
web: ./node_modules/.bin/rollup -c rollup-build.config.js -o dist/index.js -f iife -n UiZoo -g underscore:_,react:React,react-dom:ReactDOM,react-router-dom:ReactRouterDOM,doctrine:doctrine-standalone,babel-standalone:Babel && node server/main.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
# React Bibliotheca - Dynamic React components library | ||
Try our live example [here](http://react-bibliotheca.herokuapp.com). | ||
> "Donde, está, la biblioteca. Me llamo T-Bone La araña discoteca. Discoteca, muñeca, La biblioteca..." | ||
\- Troy and Abed. | ||
# UiZoo.js - Dynamic React components library | ||
Try our live example [here](https://uizoo.herokuapp.com/). | ||
|
||
## About | ||
How many times did you create a new component just to find later someone already did the exact same? | ||
How many times did you find out that a "generic" component you wanted to use is actually tightly-coupled to the environment it was developed upon? | ||
Well, no more! introducing - **La Bibliotheca** | ||
Well, no more! introducing - **UiZoo.js** | ||
|
||
It will showcase **your components**, letting you develop in a sterile environment and browse what you already have and can use, to better re-use your components. | ||
And all this with almost no effort! | ||
|
@@ -17,47 +16,38 @@ This tool can be used for developing, for Product Managers to know what is possi | |
|
||
![React Bibliotheca 3](https://media.giphy.com/media/MqhUcIhANah9e/giphy.gif) | ||
|
||
## How To Bibliotheca? | ||
Either git clone by: | ||
## How To UiZoo? | ||
Git clone by: | ||
``` | ||
git clone [email protected]:myheritage/react-bibliotheca.git | ||
git clone [email protected]:myheritage/uizoo.js.git | ||
``` | ||
then | ||
``` | ||
cd react-bibliotheca && npm i | ||
cd uizoo.js && npm i | ||
gulp | ||
``` | ||
This will start a server on http://localhost:5000 with the Bibliotheca | ||
you can change the [components file](https://github.com/myheritage/react-bibliotheca/blob/master/client/components.js) and the [documentation file](https://github.com/myheritage/react-bibliotheca/blob/master/client/documentation.js) to start rapidly. | ||
This will start a server on http://localhost:5000 with the UiZoo | ||
you can change the [components file](https://github.com/myheritage/uizoo.js/blob/master/client/components.js) and the [documentation file](https://github.com/myheritage/uizoo.js/blob/master/client/documentation.js) to start rapidly. | ||
We recommend updating those files by a script automatically when files are changing (we plan to create plugins to help with this in the next future). | ||
|
||
**or** npm install by: | ||
``` | ||
npm i -S bibliotheca | ||
``` | ||
then in your code, add: | ||
``` | ||
import 'bibliotheca/dist/index.css'; | ||
import Bibliotheca from 'bibliotheca'; | ||
Bibliotheca.init(bibliothecaDocumentation, bibliothecaComponents, rootElement); | ||
``` | ||
*NPM module will be added soon* | ||
|
||
### init | ||
``` | ||
Bibliotheca.init(bibliothecaDocumentation, bibliothecaComponents, rootElement): | ||
UiZoo.init(documentation, components, rootElement): | ||
``` | ||
|
||
**bibliothecaDocumentation** - Object, mapping of component name to its documentation. See [example](https://github.com/myheritage/react-bibliotheca/blob/master/client/documentation.js). | ||
**documentation** - Object, mapping of component name to its documentation. See [example](https://github.com/myheritage/uizoo.js/blob/master/client/documentation.js). | ||
|
||
**bibliothecaComponents** - Object, mapping of components name to components. See [example](https://github.com/myheritage/react-bibliotheca/blob/master/client/components.js). | ||
**components** - Object, mapping of components name to components. See [example](https://github.com/myheritage/uizoo.js/blob/master/client/components.js). | ||
|
||
**rootElement** - HTMLElement, will bootstrap the Bibliotheca on that Element. Default is an element with the id 'bibliotheca_root' | ||
**rootElement** - HTMLElement, will bootstrap UiZoo on that Element. Default is an element with the id 'library-_-root' | ||
|
||
**baseRoute** Route to be the base before the Bibliotheca routes. Default to '/'. for example if the Bibliotheca is on your site like so: 'www.mysite.com/my/bib/', the base route should be '/my/bib/'. | ||
**baseRoute** Route to be the base before the UiZoo routes. Default to '/'. for example if the UiZoo is on your site like so: 'www.mysite.com/my/zoo/', the base route should be '/my/zoo/'. | ||
|
||
## JSDoc support | ||
We support many [JSDoc](http://usejsdoc.org/) conventions. | ||
Check out our [example UI library](https://github.com/myheritage/react-bibliotheca/tree/master/client/Components/BibliothecaUI) and see its component documentation. Cool, right? | ||
Check out our [example UI library](https://github.com/myheritage/uizoo.js/tree/master/client/Components/UI) and see its component documentation. Cool, right? | ||
|
||
### Supported JSDoc Block Tags | ||
#### @name (synonyms: @class, @type) | ||
|
@@ -87,15 +77,15 @@ See video example: | |
## Contributing | ||
|
||
Contributions and feedback are very welcome! Feel free to open issues. | ||
See our [guidelines](https://github.com/myheritage/react-bibliotheca/blob/master/CONTRIBUTING.md). | ||
See our [guidelines](https://github.com/myheritage/uizoo.js/blob/master/CONTRIBUTING.md). | ||
|
||
--- | ||
|
||
## Tests | ||
|
||
The tests package is isolated and located inside the /tests folder. | ||
The target of the tests is to run locally before committing changes and to be a sanity indicator that everything is okay. | ||
Tests are written in Protractor with Karma and they cover the Bibliotheca from end-to-end. | ||
Tests are written in Protractor with Karma and they cover the project from end-to-end. | ||
|
||
### Run the tests once | ||
To perform the tests once, run: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 5 additions & 5 deletions
10
client/Components/ComponentExamples/ComponentExample/index.scss
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,20 @@ | ||
.bibliotheca-component-example { | ||
.bibliotheca-example-title { | ||
.library-_-component-example { | ||
.library-_-example-title { | ||
margin: 0 0 10px; | ||
font-size: 14px; | ||
font-weight: 500; | ||
display: inline-block; | ||
} | ||
.bibliotheca-code-card-frame { | ||
.library-_-code-card-frame { | ||
position: relative; | ||
} | ||
.bibliotheca-try-it-button { | ||
.library-_-try-it-button { | ||
position: absolute; | ||
top: 0; | ||
right: 0; | ||
z-index: 1; | ||
} | ||
.bibliotheca-code-card-wrapper { | ||
.library-_-code-card-wrapper { | ||
padding-right: 60px; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
client/Components/ComponentParams/ParamSelector/ParamSelectorBoolean/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
client/Components/ComponentParams/ParamSelector/ParamSelectorVariant/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.