Skip to content

Commit d889ce6

Browse files
committed
added readme
1 parent ca74e31 commit d889ce6

5 files changed

Lines changed: 42 additions & 12 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,47 @@
1-
# reactnativebase
1+
<h1 align="center"> React Native Base Template </h1>
22

3-
Fasky's Basic React Native Template
3+
<p align="center">
4+
<img alt="GitPoint" title="GitPoint" src="./assets/fasky.png" width="80">
5+
<img alt="GitPoint" title="GitPoint" src="./assets/react_native.png" width="120">
6+
<img alt="GitPoint" title="GitPoint" src="./assets/firebase.png" width="250">
7+
</p>
48

5-
1. npx react-native init reactnativebase --template react-native-template-typescript
6-
2. cd reactnativebase
9+
<p align="center">
10+
<img alt="showcase" src="./assets/cli.png" width="700">
11+
</p>
712

8-
Setup Translations (optional)
9-
x. npm install --save react-i18next i18next
13+
<div align="center">
14+
<strong>Basic React Native Project with some useful components</strong>
15+
</div>
16+
<div align="center">
17+
</div>
1018

11-
Setup Firebase (optional)
12-
x. npm install --save @react-native-firebase/app
13-
https://invertase.io/oss/react-native-firebase/quick-start/android-firebase-credentials
14-
https://invertase.io/oss/react-native-firebase/quick-start/ios-firebase-credentials
19+
## Table of Contents πŸ“š
1520

16-
Setup Navigation
17-
npm install @react-navigation/native @react-navigation/bottom-tabs react-native-reanimated react-native-gesture-handler react-native-screens react-native-safe-area-context @react-native-community/masked-view
21+
- [Installation πŸ”§](#introduction)
22+
- [Usage πŸ’‘](#usage)
23+
- [Tech 🏷](#tech)
24+
- [Development πŸ’»](#development)
25+
- [Contributors πŸ€“](#Contributors-)
26+
27+
## Usage πŸ’‘
28+
29+
The <a href="https://www.npmjs.com/package/fasky-cli">fasky-cli</a> helps you to set up a best practice react native project within seconds. The cli is based on this project.
30+
31+
## Tech 🏷
32+
33+
- React Native 0.61.5
34+
- i18N
35+
- react-navigation v5
36+
37+
## Development πŸ’»
38+
39+
- Install dependencies `npm install`
40+
- Compile iOS `npx react-native run-ios`
41+
- Compile Android `npx react-native run-android`
42+
43+
## Contributors πŸ€“
44+
45+
| [<img alt="Thomas Leiter" src="https://avatars3.githubusercontent.com/u/20393156?s=400&u=ae0a43de5d81d58a698abffe4e2ede024f2b6700&v=4" width="117">](https://github.com/tomLadder) | [<img alt="Thomas Leiter" src="https://avatars2.githubusercontent.com/u/11005451?s=460&v=4" width="117">](https://github.com/sutefan1) |
46+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
47+
| <p align="center">[Max Haider](https://github.com/MaxHaider) </p> | <p align="center">[Thomas Leiter](https://github.com/tomLadder) </p> | <p align="center">[Stefan Papst](https://github.com/sutefan1) </p> |

β€Žassets/cli.pngβ€Ž

206 KB
Loading

β€Žassets/fasky.pngβ€Ž

9.97 KB
Loading

β€Žassets/firebase.pngβ€Ž

16.7 KB
Loading

β€Žassets/react_native.pngβ€Ž

34.8 KB
Loading

0 commit comments

Comments
Β (0)