Skip to content

Commit 9082463

Browse files
justinkxjustinkx
committed
updated license and readme files
1 parent c663b1e commit 9082463

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

‎LICENSE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Fidisys Technologies Pvt Ltd.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<img src="https://user-images.githubusercontent.com/28846043/66642659-cb9f8c00-ec3a-11e9-9b88-de212cb16e0b.png" alt="react boilerplate banner" align="center" />
2+
3+
<br />
4+
5+
<div align="center"><strong>Start Your Next React Native Project In Seconds</strong></div>
6+
<div align="center">A highly scalable, redux state management, sagas middleware integrated setup focus on performance and best practices</div>
7+
8+
<br />
9+
10+
<div align="center">
11+
<!-- Dependency Status -->
12+
<a href="https://david-dm.org/fidisys/react-native-boilerplate">
13+
<img src="https://david-dm.org/fidisys/react-native-boilerplate.svg" alt="Dependency Status" />
14+
</a>
15+
<!-- devDependency Status -->
16+
<a href="https://david-dm.org/fidisys/react-native-boilerplate#info=devDependencies">
17+
<img src="https://david-dm.org/fidisys/react-native-boilerplate/dev-status.svg" alt="devDependency Status" />
18+
</a>
19+
<!-- Build Status -->
20+
<a href="https://travis-ci.org/fidisys/react-native-boilerplate">
21+
<img src="https://travis-ci.org/fidisys/react-native-boilerplate.svg" alt="Build Status" />
22+
</a>
23+
<!-- Test Coverage -->
24+
25+
</div>
26+
27+
28+
<br />
29+
30+
<div align="center">
31+
<sub>Created by <a href="https://github.com/justinkx">Justin K Xavier</a> and maintained with ❤️ by <a href="https://dribbble.com/fidisys">Fidisys</a></sub>
32+
</div>
33+
34+
# React Native Boilerplate
35+
36+
React Native boilerplate using react-native-cli with react-navigation, redux state management, redux-saga middleware and auth flow mechanism with drawer-tab navigation layout.
37+
38+
39+
## Prerequisites
40+
41+
What things you need to install the software and how to install them
42+
43+
1. Node (v10.9 and above)
44+
2. Android studio with sdk tools installed
45+
3. Java (jdk 9 and above)
46+
4. Xcode (for ios build)
47+
5. React native cli
48+
```
49+
npm install -g react-native-cli
50+
```
51+
___
52+
## Installing
53+
54+
55+
1. Clone the boilerplate.
56+
```
57+
git clone https://github.com/fidisys/react-native-boilerplate.git
58+
```
59+
2. Install all the dependencies
60+
And repeat
61+
62+
```
63+
npm install
64+
```
65+
3. Go to project folder and start server.
66+
67+
```
68+
react-native start
69+
```
70+
4. Run the project on android/ios
71+
72+
```
73+
react-native run <android/ios>
74+
```
75+
76+
## Packages used for scaffolding
77+
78+
- react
79+
- react-native
80+
- react-navigation
81+
- react-native-gesture-handler
82+
- react-native-vector-icons
83+
- redux
84+
- react-redux
85+
- redux-saga
86+
87+
88+
### React-Native Debugger
89+
![React Native Debugger](https://user-images.githubusercontent.com/3001525/29451479-6621bf1a-83c8-11e7-8ebb-b4e98b1af91c.png)
90+
91+
* This is a standalone app for debugging React Native apps
92+
- Based on official [Remote Debugger](https://facebook.github.io/react-native/docs/debugging.html#chrome-developer-tools) and provide more functionally.
93+
- Includes [React Inspector](docs/react-devtools-integration.md) from [`react-devtools-core`](https://github.com/facebook/react-devtools/tree/master/packages/react-devtools-core).
94+
- Includes Redux DevTools, made [the same API](docs/redux-devtools-integration.md) with [`redux-devtools-extension`](https://github.com/zalmoxisus/redux-devtools-extension).
95+
96+
#### Installation
97+
98+
To install the app, you can download a prebuilt binary from the [release page](https://github.com/jhen0409/react-native-debugger/releases).
99+
100+
For **macOS**, you can use [Homebrew Cask](https://caskroom.github.io) to install:
101+
102+
```bash
103+
$ brew update && brew cask install react-native-debugger
104+
```
105+
106+
This puts `React Native Debugger.app` in your `/applications/` folder.
107+
108+
#### [Official Page](https://github.com/jhen0409/react-native-debugger)
109+
110+
___
111+
112+
## Authors
113+
114+
* **Justin K Xavier** - *Initial work* - [LinkedIn](https://www.linkedin.com/in/justin-k-xavier-59b82710a/)
115+
* **prasanth kumar lalapeta** - [Github](https://github.com/prasanthLalapeta)
116+
117+
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
118+
119+
## License
120+
121+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
122+
___
123+
124+
125+
<p align="center">😊Pull requests accepted with ❤️</p>
126+

0 commit comments

Comments
 (0)