Ocelot-Social/README.md
2018-12-15 12:48:05 +01:00

42 lines
786 B
Markdown

# Human Connection - NITRO Web
[![Build Status](https://travis-ci.com/Human-Connection/Nitro-Web.svg?branch=master)](https://travis-ci.com/Human-Connection/Nitro-Web)
![UI Screenshot](screenshot.png)
## Build Setup
### Install
``` bash
# install all dependencies
$ cd styleguide && yarn install && cd ..
$ yarn styleguide:build
$ yarn install
```
### Development
``` bash
# serve with hot reload at localhost:3000
$ yarn dev
```
### Build for production
``` bash
# build for production and launch server
$ yarn styleguide:build
$ 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
```