Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 35 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,52 @@
# LIGHTELLIGENCE design system (React version)
<a href="https://lightelligence.io" align="right">
<img src="/resources/logo.png" alt="logo" title="logo" align="right" />
</a>

[User Documentation](https://developers.lightelligence.io/react)
# React

React components for the lightelligence platform.
[![Build Status](https://img.shields.io/travis/com/lightelligence-io/react.svg)](https://travis-ci.com/lightelligence-io/react/branches)
[![Code Coverage](https://img.shields.io/coveralls/github/lightelligence-io/react.svg)](https://coveralls.io/github/lightelligence-io/react)
[![Dependencies](https://img.shields.io/david/lightelligence-io/react.svg)](https://david-dm.org/lightelligence-io/react)
[![npm (scoped)](https://img.shields.io/npm/v/@lightelligence/react.svg)](https://www.npmjs.com/package/@lightelligence/react)

## Getting Started
> The Lightelligence design system React Components

Install dependencies
## Installation

```
npm install
npm install @lightelligence/react
```

Run development server on port 5050.
## Features

```
npm run start
```

## Running the tests
Lightelligence React is a set of React components, styled according to our
design system. It is a React.js implementation of
[Lightelligence Styles](https://github.com/lightelligence-io/styles).

Run unit tests
`npm run test`
## Usage

### And coding style tests
Make sure to include the bundled CSS in your React Application as well as
wrapping your content in [`<Frame />`](https://lightelligence-io.github.io/react/#/Components/Frame)
component.

- JavaScript/React: [airbnb coding guidelines](https://www.npmjs.com/package/eslint-config-airbnb).
- Code formatting: [prettier](https://github.com/prettier/prettier).
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import '@lightelligence/react/dist/index.css';
import { Button, Frame, COLOR_PRIMARY } from '@lightelligence/react';

Please, consider installing eslint and prettier plugins for your IDE.
const App = () => (
<Frame>
<Button color={COLOR_PRIMARY}>Hello World</Button>
</Frame>
);

### Build

Build all project parts by using node scripts.

## Built With
ReactDOM.render(<App />, document.getElementById('root'));
```

- [react](https://reactjs.org/)
- [LIGHTELLIGENCE CSS styleguide](https://github.com/lightelligence-io/styles) The CSS implementation of the lightelligence design-system
Check out [the API reference](https://lightelligence-io.github.io/react/)
to see the full documentation.

## Contributing
## License

## Acknowledgments
MIT
Binary file added resources/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.