Skip to content

Commit

Permalink
fix: readme image issues fixed using absolute path
Browse files Browse the repository at this point in the history
  • Loading branch information
Ajamuar committed Jun 22, 2021
1 parent c0ff91e commit 134e313
Showing 1 changed file with 34 additions and 105 deletions.
139 changes: 34 additions & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# <img src="./img/header1.png" alt="Nativebase Logo">
# <img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/header1.png" alt="Nativebase Logo">

[![Financial Contributors on Open Collective](https://opencollective.com/NativeBase/all/badge.svg?label=financial+contributors)](https://opencollective.com/NativeBase) [![](http://slack.nativebase.io/badge.svg)](http://slack.nativebase.io/) [![Build Status](https://travis-ci.org/GeekyAnts/NativeBase.svg?branch=master)](https://travis-ci.org/GeekyAnts/NativeBase) [![npm version](https://badge.fury.io/js/native-base.svg)](https://badge.fury.io/js/native-base) [![npm downloads](https://img.shields.io/npm/dt/native-base.svg)](https://npm-stat.com/charts.html?package=native-base&from=2016-04-01&to=2018-02-17)

## NativeBase is a mobile-first, accessible component library for building a consistent design system across android, iOS & web.

[**Website**](https://nativebase.io/)
<br/>
[**Documentation**](https://docs.nativebase.io/)
Expand All @@ -13,7 +14,7 @@
2. [Motivation](#2-motivation)
3. [Features](#3-features)
4. [Dependencies](#4-dependencies)
5. [Installation & Setup](#5-installation-&-setup)
5. [Installation & Setup](#5-installation)
6. [Components](#6-components)
7. [Examples](#7-examples)
8. [KitchenSink App](#8-kitchensink-app)
Expand All @@ -24,14 +25,16 @@
13. [Community](#13-community)
14. [License](#14-license)


## 1. Introduction?

[NativeBase](https://nativebase.github.io/) is a mobile-first, component library for React & React Native. Version 3.0 ships with complete ARIA integration, support for utility props and nearly 40 components that are consistent across Android, iOS and Web. Fast-track your dev process with NativeBase 3.0.

**Recommended by [Awesome React Native](https://github.com/jondot/awesome-react-native)**

> NativeBase was added to the list of Frameworks of Awesome React Native and it is used by numerous React lovers across the world.
## 2. Motivation

Building with React Native from scratch is a tedious process with multiple steps such as adding styling, interactions, state management, responsiveness, accessibility, etc. We wanted to build and ship accessible, high-quality apps quickly.
<br />

Expand All @@ -43,7 +46,7 @@ Our inspirations include Material UI, Chakra UI, Ant Design, Braid Design System

Integrated with React ARIA and React Native ARIA, which provides React hooks. This enables you to build accessible design systems in no time.

<img src="./img/feature.png" alt="Out of the box accessibility">
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/feature.png" alt="Out of the box accessibility">

### **Supporting Utility Props**

Expand All @@ -57,7 +60,7 @@ NativeBase offers around 40 components so you can build seamlessly. It includes

Themeability is one of the core elements of NativeBase. You can customise your app theme and component styles to your heart's content.

<img src="./img/theme.png" alt="Nativebase Logo">
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/theme.png" alt="Nativebase Logo">

### **Available for Both Mobile and Web**

Expand All @@ -75,94 +78,17 @@ Building apps with a dark mode setting just got a whole lot easier. NativeBase i

React Native, Expo

## 5. Installation & Setup

To start using NativeBase components in your native apps, create a new React Native project. [Expo](https://docs.expo.io/get-started/installation/) is a great starting point so let's set it up, install NativeBase using yarn/npm and add all the peer dependencies. To get `NativeBase` running onto your native apps, install it using `npm` or `yarn`.

### Setup with React Native

```bash
react-native init AwesomeNativeBase
cd AwesomeNativeBase
```

*Install **NativeBase***

```bash
# using yarn
yarn add native-base@next react-native-svg styled-components styled-system react-native-safe-area-context
```

```bash
# using npm
npm install native-base@next react-native-svg styled-components styled-system react-native-safe-area-context
```

*Run pod install*

```bash
cd ios/
pod install
```

You've successfully setup [NativeBase](https://nativebase.io/) with your [React Native](https://reactnative.dev/) app. Your React Native app is ready to run on iOS and Android devices.

### Setup with Expo

Expo helps you to create universal (iOS, Android and Web) React Native apps with no build configuration.
## 5. Installation

*Install **NativeBase***
NativeBase is supported in Expo or React Native CLI initiated apps. Web support is made possible by react-native-web.

```bash
# using yarn
yarn add native-base@next styled-components styled-system
expo install react-native-svg
expo install react-native-safe-area-context
```

```bash
# using npm
npm install native-base@next styled-components styled-system
expo install react-native-svg
expo install react-native-safe-area-context
```

### Setup for Next.js with Expo for Web

```bash
# using yarn
yarn add native-base@next react-native-svg @expo/vector-icons styled-components styled-system
```

```bash
# using npm
npm i native-base@next react-native-svg @expo/vector-icons styled-components styled-system
```

By default Next.js doesn't support static assets like an Expo project. Because this is the intended functionality of Next.js, @expo/next-adapter doesn't add font support by default. If you want to use libraries like expo-font, @expo/vector-icons, you'll need to change a few things.

```bash
yarn add next-fonts
```
Wrap the font method with the Expo method in your next.config.js:

```js
const { withExpo } = require('@expo/next-adapter');
const withFonts = require('next-fonts');

module.exports = withExpo(
withFonts({
projectRoot: __dirname,
})
);
```
The order is important because Expo can mix in the location of vector icons to the existing font loader.Now restart your project and you should be able to load fonts!
Refer the [guides](https://alpha-docs.nativebase.io/installation) to setup NativeBase in your React app.

## 6. Components

NativeBase 3.0 is a rich component library with nearly 40 components.
- [**Layout**](https://docs.nativebase.io/box)

- [**Layout**](https://docs.nativebase.io/box)
- [**Forms**](https://docs.nativebase.io/button)
- [**Data Display**](https://docs.nativebase.io/badge)
- [**Feedback**](https://docs.nativebase.io/alert)
Expand All @@ -172,19 +98,18 @@ NativeBase 3.0 is a rich component library with nearly 40 components.
- [**Media & Icons**](https://docs.nativebase.io/avatar)
- [**Transition**](https://docs.nativebase.io/presence-transition)
- [**Other**](https://docs.nativebase.io/FAB)


## 7. Examples

[Check out the Login Screen example](https://docs.nativebase.io/todo-example)


## 8. KitchenSink App

Kitchen Sink is a comprehensive demo app showcasing all the NativeBase components in action. It includes buttons, forms, icons, etc.

<div class="flexible">
<img src="./img/kitchensink.gif" height="500px" alt="Kitchensink App gif">
<img src="./img/qr.png" height="500px" alt="Kitchensink App QR code">
<img src="https://github.com/GeekyAnts/NativeBase/raw/development/img/kitchensink.gif" height="500px" alt="Kitchensink App gif">
<img src="https://raw.githubusercontent.com/GeekyAnts/NativeBase/development/img/qr.png" height="500px" alt="Kitchensink App QR code">
</div>

## 9. Tech Stack
Expand All @@ -193,20 +118,20 @@ JavaScript, React Native, Styled System

## 10. Compatible Versions

| NativeBase | React Native |
| --------------------------------|-------------------------|
| v0.1.1 | v0.22 to v0.23 |
| v0.2.0 to v0.3.1 | v0.24 to v0.25 |
| v0.4.6 to v0.4.9 | v0.26.0 - v0.27.1 |
| v0.5.0 to v0.5.15 | v0.26.0 - v0.37.0 |
| v0.5.16 to v0.5.20 | v0.38.0 - v0.39.0 |
| v2.0.0-alpha1 to v2.1.3 | v0.38.0 to v0.43.0 |
| v2.1.4 to v2.1.5 | v0.44.0 to v0.45.0 |
| v2.2.0 | v0.44.0 to v0.45.0 |
| v2.2.1 | v0.46.0 and above |
| v2.3.0 to 2.6.1 | v0.46.0 and above (does not support React 16.0.0-alpha.13) |
| v2.7.0 | v0.56.0 and above |
| v3.0.0-next.36 to v3.0.0-next-41 | v0.63.0 and above |
| NativeBase | React Native |
| -------------------------------- | ---------------------------------------------------------- |
| v0.1.1 | v0.22 to v0.23 |
| v0.2.0 to v0.3.1 | v0.24 to v0.25 |
| v0.4.6 to v0.4.9 | v0.26.0 - v0.27.1 |
| v0.5.0 to v0.5.15 | v0.26.0 - v0.37.0 |
| v0.5.16 to v0.5.20 | v0.38.0 - v0.39.0 |
| v2.0.0-alpha1 to v2.1.3 | v0.38.0 to v0.43.0 |
| v2.1.4 to v2.1.5 | v0.44.0 to v0.45.0 |
| v2.2.0 | v0.44.0 to v0.45.0 |
| v2.2.1 | v0.46.0 and above |
| v2.3.0 to 2.6.1 | v0.46.0 and above (does not support React 16.0.0-alpha.13) |
| v2.7.0 | v0.56.0 and above |
| v3.0.0-next.36 to v3.0.0-next-41 | v0.63.0 and above |

## 11. Contributors

Expand Down Expand Up @@ -241,12 +166,16 @@ Support this project with your organization. Your logo will show up here with a
## 12. Changelog

[Check out the changelog in the official documentation](https://docs.nativebase.io/changelog)

## 13. Community

- [Facebook](https://www.facebook.com/nativebaseio)
- [Twitter](https://twitter.com/nativebaseio)
- [Discord](https://discord.com/invite/TSgCw2UPmb)
- [Stackoverflow](https://stackoverflow.com/questions/tagged/native-base)
- [Blog](https://techblog.nativebase.io/)
- [YouTube](https://www.youtube.com/channel/UCoL_iTwpY07vDs91974z3xA/about)

## 14. License

Licensed under the MIT License, Copyright © 2020 GeekyAnts. See [LICENSE](https://github.com/GeekyAnts/NativeBase/blob/master/LICENSE) for more information.

0 comments on commit 134e313

Please sign in to comment.