|
1 | | -### Install Dependencies |
| 1 | +# Blueprint Components |
| 2 | + |
| 3 | +The missing components for [Blueprint](http://blueprintjs.com/). |
| 4 | + |
| 5 | +[](http://makeapullrequest.com) |
| 6 | +[](https://travis-ci.org/Landish/blueprint-components) |
| 7 | +[](https://github.com/facebook/jest) |
| 8 | +[](https://github.com/semantic-release/semantic-release) |
| 9 | +[](http://commitizen.github.io/cz-cli/) |
| 10 | +[](https://github.com/prettier/prettier) |
| 11 | +[](https://github.com/Landish/blueprint-components/blob/master/LICENSE) |
| 12 | + |
| 13 | + |
| 14 | +## Getting Started |
| 15 | + |
| 16 | +Install Blueprint Components |
| 17 | + |
| 18 | +``` |
| 19 | +yarn add blueprint-components |
| 20 | +``` |
| 21 | + |
| 22 | +Add specific component to your project: |
| 23 | + |
| 24 | +```js |
| 25 | +import { ButtonGroup, Label, Navbar, ... } from 'blueprint-components'; |
| 26 | +``` |
| 27 | + |
| 28 | +### Avalaible Components: |
| 29 | + |
| 30 | +* [Button Group](https://landish.github.io/blueprint-components/#buttongroup) |
| 31 | +* [Callout](https://landish.github.io/blueprint-components/#callout) |
| 32 | +* [Card](https://landish.github.io/blueprint-components/#card) |
| 33 | +* [Control Group](https://landish.github.io/blueprint-components/#controlgroup) |
| 34 | +* [File Input](https://landish.github.io/blueprint-components/#fileinput) |
| 35 | +* [Form Group](https://landish.github.io/blueprint-components/#formgroup) |
| 36 | +* [Label](https://landish.github.io/blueprint-components/#label) |
| 37 | +* [Navbar](https://landish.github.io/blueprint-components/#navbar) |
| 38 | + |
| 39 | +## Contirbution |
| 40 | + |
| 41 | +PR's are welcome. If you found a bug, typo, or just want to add new features or examples to docs, feel free to make a pull request. |
| 42 | + |
2 | 43 | ``` |
| 44 | +git clone [email protected]:Landish/blueprint-components.git |
| 45 | +cd blueprint-components |
3 | 46 | yarn |
4 | 47 | ``` |
5 | 48 |
|
6 | | -### Run Docs |
| 49 | +Once you've forked/cloned the repo, you can fix the bug, or add new feature. |
| 50 | + |
| 51 | +If you need to open docs on local machine, run the following command: |
| 52 | + |
7 | 53 | ``` |
8 | 54 | yarn docs |
9 | 55 | ``` |
10 | 56 |
|
11 | | -Visit [http://localhost:6060/](http://localhost:6060/) |
| 57 | +Then visit [http://localhost:6060/](http://localhost:6060/) |
| 58 | + |
| 59 | +If you need to check the tests, run the command: |
| 60 | + |
| 61 | +``` |
| 62 | +yarn test |
| 63 | +# Or run the tests in `watch` mode |
| 64 | +yarn test:watch |
| 65 | +``` |
| 66 | + |
| 67 | +After you've made your changes, add files to git stage with `git add <file(s)>` and then run the following command instead of `git commit -m "your message"`: |
| 68 | + |
| 69 | +``` |
| 70 | +yarn cz |
| 71 | +``` |
| 72 | + |
| 73 | +It will prompt few questions from [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog). After you answer them correctly, you're ready to make a pull request. |
| 74 | + |
| 75 | +> Note: Don't worry about formatting the code, [prettier](https://github.com/prettier/prettier) will do it for you with `precommit` hook, thanks to [husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged). |
| 76 | +
|
| 77 | + |
| 78 | +## Licence |
| 79 | + |
| 80 | +The Blueprint Components package is licensed under [MIT License](https://github.com/Landish/blueprint-components/blob/master/LICENSE). |
| 81 | + |
| 82 | +> Note: [Blueprint](http://blueprintjs.com/) itself is licensed under [BSD](https://github.com/palantir/blueprint/blob/master/LICENSE). |
0 commit comments