Ocelot-Social/README.md
Grzegorz Leoniec 6cf21c1876 updated readme
2018-10-10 14:53:35 +02:00

44 lines
758 B
Markdown

# Human Connection - GraphQL UI Prototype
> Ui Prototype for HC
![UI Screenshot](screenshot.png)
## Build Setup
### Install
``` bash
# install all dependencies
$ yarn install
```
### Development
``` bash
# serve with hot reload at localhost:3000
$ yarn dev
```
### Build for production
``` bash
# build for production and launch server
$ yarn build
$ yarn start
```
## Styleguide
All reusable Components (for example avatar) should be done inside the styleguide directory.
![Styleguide Screenshot](screenshot-styleguide.png)
### To show the styleguide
``` bash
$ yarn styleguide
```
if you changed design tokens or other styles inside the styleguide, run the refresh command to build the styleguide as a lib
``` bash
$ yarn styleguide:build
```