Ocelot-Social/README.md
2018-12-18 14:53:00 +01:00

54 lines
1.4 KiB
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
```
## Internationalization (i18n)
You can help translating the interface by joining us on [lokalise.co](https://lokalise.co/public/556252725c18dd752dd546.13222042/).
Thanks lokalise.co that we can use your premium account!
<a href="(https://lokalise.co/public/556252725c18dd752dd546.13222042/)."><img src="lokalise.png" alt="localise.co" height="32px" /></a>
## Attributions
<div>Locale Icons made by <a href="http://www.freepik.com/" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></div>