|
1 |
| -<img src="https://cdn.rawgit.com/akveo/react-native-ui-kitten/085afb52/docs/assets/banner.png"/> |
2 | 1 |
|
3 |
| -# react-native-ui-kitten [![Build Status][badge-travis]][link-travis] [![Coverage Status][badge-coveralls]][link-coveralls] [![Dependency Status][badge-david]][link-david] [![npm][badge-downloads]][link-downloads] [![npm][badge-license]]() |
| 2 | +# UI Kitten [<img src="https://i.imgur.com/oMcxwZ0.png" alt="Eva Design System" height="20px" />][link:eva] [![npm][badge:license]]() [![Build Status][badge:travis]][link:travis] [![Coverage Status][badge:coveralls]][link:coveralls] |
4 | 3 |
|
5 |
| -This branch contains sources of something really awesome. |
6 |
| -We do what we did before but in a new way. |
| 4 | +[Documentation][link:doc-homepage] |
7 | 5 |
|
8 |
| -## What's new will you have: |
9 |
| -- TypeScript support |
10 |
| -- Full test coverage of the framework |
11 |
| -- Better code quality |
12 |
| -- Better development environment for contributors |
13 |
| -- Better theme system |
| 6 | +UI Kitten is a React Native UI Library that allows you creating stunning multi-brand cross-platform mobile applications. |
| 7 | +The library is based on Eva Design System which brings consistency and scalability in the design and development process. |
| 8 | +It contains a set of general purpose UI components styled in a similar way. |
| 9 | +And the most awesome thing: the themes can be changed in the runtime, with no need to reload the application. |
14 | 10 |
|
15 |
| -## How can I support the developers? |
16 |
| -- Star our GitHub repo |
17 |
| -- Create pull requests, submit bugs, suggest new features or documentation updates |
18 |
| -- Follow us on [Twitter](https://twitter.com/akveo_inc) |
19 |
| -- Like our page on [Facebook](https://www.facebook.com/akveo/) |
| 11 | +100% Free and Open Source! |
| 12 | + |
| 13 | +[<img src="https://i.imgur.com/pYl0trU.jpg">][link:doc-homepage] |
| 14 | + |
| 15 | +## What's included |
| 16 | + |
| 17 | +- **20+ general-purpose components** designed and tested to save your time. |
| 18 | + |
| 19 | +- **Comprehensive clear documentation** with the tons of examples. |
| 20 | + |
| 21 | +- **Theming System.** Use Light and modern Dark themes and create your own. |
| 22 | + |
| 23 | +- **Eva Design System Support.** Construct an interface using basic components following Eva specifications and it will always have a stunning design. |
| 24 | + |
| 25 | +## Starter App |
| 26 | + |
| 27 | +**Kitten Tricks** – [react-native starter kit][link:kitten-tricks] allows you to boost the development of a mobile app. |
| 28 | +There is a huge variety of customizable layouts, use “as is” or add new blocks. |
20 | 29 |
|
21 |
| -## Can I hire you guys? |
22 |
| -Yes! We are available for hire. Visit [our homepage](http://akveo.com/) or simply leave us a message at contact@akveo.com. We will be happy to work with you! |
| 30 | +**Over 40 screens in dark and light themes** give you the possibility to create a bright and exclusive app while saving your time on compiling numerous details. Also, you can download the source code and use it for your own benefit. |
| 31 | + |
| 32 | +## Quick Start |
| 33 | + |
| 34 | +Install UI Kitten and Eva Design System packages via npm: |
| 35 | + |
| 36 | +```bash |
| 37 | +npm i react-native-ui-kitten @eva-design/eva |
| 38 | +``` |
| 39 | + |
| 40 | +Modify your application root: |
| 41 | + |
| 42 | +```jsx |
| 43 | +import React from 'react'; |
| 44 | +import { mapping, theme } from '@eva-design/eva'; |
| 45 | +import { ApplicationProvider } from 'react-native-ui-kitten'; |
| 46 | +import { Application } from './path-to/application.component'; |
| 47 | + |
| 48 | +export default App = () => ( |
| 49 | + <ApplicationProvider |
| 50 | + mapping={mapping} |
| 51 | + theme={theme} |
| 52 | + <Application/> |
| 53 | + </ApplicationProvider> |
| 54 | +); |
| 55 | +``` |
| 56 | + |
| 57 | +The code above will configure your application component to apply Eva Design System styling magic. |
| 58 | +Read the [Theme System guide][link:doc-theme-system] for more details. |
| 59 | + |
| 60 | +## How can I support the developers? |
| 61 | +- Star our GitHub repo :star: |
| 62 | +- Create pull requests, submit bugs, suggest new features or documentation updates :wrench: |
| 63 | +- Read us on [Medium][link:akveo-medium] |
| 64 | +- Follow us on [Twitter][link:akveo-twitter] |
| 65 | +- Like our page on [Facebook][link:akveo-facebook] |
23 | 66 |
|
24 |
| -License |
25 |
| -------------- |
26 |
| -<a href=/LICENSE.txt target="_blank">MIT</a> license. |
| 67 | +## License |
| 68 | +[MIT](LICENSE.txt) license. |
27 | 69 |
|
28 |
| -### From akveo |
| 70 | +## More from Akveo |
| 71 | +- [Eva Icons][link:eva-icons] - 480+ beautiful Open Source icons |
29 | 72 |
|
30 |
| -Enjoy! |
31 |
| -We're always happy to receive your feedback. |
| 73 | +## From Developers |
| 74 | +Made with :heart: by [Akveo team][link:akveo-homepage]. Follow us on [Twitter][link:akveo-twitter] to get the latest news first! |
| 75 | +We're always happy to receive your feedback! |
32 | 76 |
|
33 |
| -[badge-travis]: https://travis-ci.com/akveo/react-native-ui-kitten.svg?branch=next |
34 |
| -[badge-coveralls]: https://coveralls.io/repos/github/akveo/react-native-ui-kitten/badge.svg?branch=next |
35 |
| -[badge-david]: https://david-dm.org/akveo/react-native-ui-kitten/status.svg |
36 |
| -[badge-downloads]: https://img.shields.io/npm/dt/react-native-ui-kitten.svg |
37 |
| -[badge-license]: https://img.shields.io/npm/l/react-native-ui-kitten.svg |
| 77 | +[badge:license]: https://img.shields.io/npm/l/react-native-ui-kitten.svg |
| 78 | +[badge:travis]: https://travis-ci.com/akveo/react-native-ui-kitten.svg?branch=master |
| 79 | +[badge:coveralls]: https://coveralls.io/repos/github/akveo/react-native-ui-kitten/badge.svg?branch=master |
38 | 80 |
|
39 |
| -[link-travis]: https://travis-ci.com/akveo/react-native-ui-kitten |
40 |
| -[link-coveralls]: https://coveralls.io/github/akveo/react-native-ui-kitten?branch=next |
41 |
| -[link-david]: https://david-dm.org/akveo/react-native-ui-kitten |
42 |
| -[link-downloads]: https://www.npmjs.com/package/react-native-ui-kitten |
| 81 | +[link:eva]: https://eva.design |
| 82 | +[link:travis]: https://travis-ci.com/akveo/react-native-ui-kitten |
| 83 | +[link:coveralls]: https://coveralls.io/github/akveo/react-native-ui-kitten?branch=master |
| 84 | +[link:doc-homepage]: https://akveo.github.io/react-native-ui-kitten |
| 85 | +[link:doc-theme-system]: https://akveo.github.io/react-native-ui-kitten/docs/guides/theme-system |
| 86 | +[link:kitten-tricks]: https://github.com/akveo/kittenTricks |
| 87 | +[link:eva-icons]: https://github.com/akveo/eva-icons |
| 88 | +[link:akveo-homepage]: https://akveo.com |
| 89 | +[link:akveo-medium]: https://medium.com/akveo-engineering |
| 90 | +[link:akveo-twitter]: https://twitter.com/akveo_inc |
| 91 | +[link:akveo-facebook]: https://www.facebook.com/akveo |
0 commit comments