diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..c41fa48 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2018 Pankod + +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: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +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. + diff --git a/README.md b/README.md new file mode 100755 index 0000000..508f265 --- /dev/null +++ b/README.md @@ -0,0 +1,267 @@ + +
+ +
+ +
+ +A well-structured React Native Boilerplate with Typescript, Redux, Jest & Enzyme support and everything you'll ever need to deploy rock solid apps. + +
+ +
+ + + Dependency Status + + + + devDependency Status + + + + Build Status + +
+ + +
+
+ Created by Pankod +
+ + + +## About + +React Native lets you build mobile apps using JavaScript. It uses the same design as React, letting you compose a rich mobile UI from declarative components. + +It offers faster mobile development, and more efficient code sharing across iOS, Android, and the Web, without sacrificing the end user’s experience or application quality. + +This boilerplate is useful to kick-start your project, as it provides latest powerfull tools which specified at the below. + +
+ +## Features + + +This boilerplate includes the latest powerfull tools. + + +* **Typescript** - Superset of JavaScript which primarily provides optional static typing, classes and interfaces. path support(allias) +* **React Navigation** - Start quickly with built-in navigators that deliver a seamless out-of-the-box experience. +* **Redux** - State management +* **Redux Persist** - Persist and rehydrate a redux store. +* **Styled Components** - Utilising tagged template literals (a recent addition to JavaScript) and the power of CSS, +* **Babel** - The compiler for next generation JavaScript. Module(alias) support +* **TSLint** - Contains TypeScript-specific options for our project. +* **CodePush** - CodePush is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users' devices. +* **React Native SVG** - React Native SVG provides SVG support to React Native on iOS and Android. +* **Splash Screen** - A splash screen API for react-native which can programatically hide and show the splash screen. Works on iOS and Android. +* **React-i18next** - Integrates I18n with React Native. Uses the user preferred locale as default. +* **Jest and Enzyme support** - Complete and ready to set-up JavaScript testing solution. Works out of the box for any React project. + + +
+ +*Here are a few highlights to look out for in this boilerplate* + +
+ +
The boilerplate includes tsconfig.json which contains a list of your input files as well as all your compilation settings.
+ + >One of TypeScript’s core principles is that type-checking focuses on the shape that values have. This is sometimes called “duck typing” or “structural subtyping”. In TypeScript, interfaces fill the role of naming these types, and are a powerful way of defining contracts within your code as well as contracts with code outside of your project. + + +
Styled Components
+ + >Styled Components allow you to write plain CSS in your components without worrying about class name collisions. It's a way to write CSS that’s scoped to a single component, and not leak to any other element in the page. + + +
CodePush
+ + >The CodePush plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the CodePush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available + +
+ +
+ +## Getting Started + + +1. Clone the repository and install the dependencies: + +```sh +git clone https://github.com/pankod/react-native-boilerplate +``` + + +2. To create a new app, go to the choosen app directory on the CLI then run one of the following methods: + +**npm** + +```sh +npm install +``` + + +3. Once the installation is done, you can run the following command: + +**ios** + + ``` + npm run ios + ``` + +**android** + + ``` + npm run android + ``` +
+ + ### Predefined commands on package.json + + + +Cache clear and restart react native bundler + + ``` + npm run clear + ``` + +Bundler analyzer + + ``` + npm run start + ``` + +Run the tests + + ``` + npm run test + ``` + +
+ + ***At this point, your project layout should look like this:*** + +
+ +``` +. +├── android +├── ios +├── scenes +│   ├── Apod +│   │   ├── __snapshots__ +│   │   │   └── index.spec.tsx.snap +│   │   ├── index.spec.tsx +│   │   ├── index.tsx +│   │   └── styled.ts +│   └── Home +│   ├── __snapshots__ +│   │   └── index.spec.tsx.snap +│   ├── index.spec.tsx +│   ├── index.tsx +│   └── styled.ts +├── src +│   ├── Actions +│   │   ├── HomeActions +│   │   │   ├── index.spec.tsx +│   │   │   └── index.ts +│   │   └── index.ts +│   ├── App.tsx +│   ├── Components +│   │   ├── Heading +│   │   │   ├── Heading.d.ts +│   │   │   ├── __snapshots__ +│   │   │   │   └── index.spec.tsx.snap +│   │   │   ├── index.spec.tsx +│   │   │   ├── index.tsx +│   │   │   └── styled.ts +│   │   └── index.ts +│   ├── Definitions +│   │   ├── ActionConsts +│   │   │   ├── index.spec.ts +│   │   │   └── index.ts +│   │   ├── Styled +│   │   │   ├── index.ts +│   │   │   └── theme.ts +│   │   └── index.ts +│   ├── I18n +│   │   ├── index.ts +│   │   └── locales +│   │   ├── en +│   │   │   ├── common.json +│   │   │   ├── home.json +│   │   │   └── index.ts +│   │   ├── es +│   │   │   ├── common.json +│   │   │   ├── home.json +│   │   │   └── index.ts +│   │   ├── index.ts +│   │   └── tr +│   │   ├── common.json +│   │   ├── home.json +│   │   └── index.ts +│   ├── Interfaces +│   │   ├── Scenes +│   │   │   └── Home.d.ts +│   │   ├── index.ts +│   │   └── styled.d.ts +│   ├── Redux +│   │   ├── IAction.d.ts +│   │   ├── IStore.d.ts +│   │   ├── Reducers +│   │   │   ├── home +│   │   │   │   ├── index.spec.ts +│   │   │   │   └── index.ts +│   │   │   └── index.ts +│   │   ├── index.ts +│   │   └── store.ts +│   ├── Router +│   │   └── index.tsx +│   ├── Services +│   │   ├── API +│   │   │   ├── Http +│   │   │   │   ├── Http.d.ts +│   │   │   │   ├── index.spec.ts +│   │   │   │   └── index.ts +│   │   │   └── Planetary +│   │   │   ├── ApodPayload.d.ts +│   │   │   ├── ApodResponse.d.ts +│   │   │   ├── Planetary.d.ts +│   │   │   ├── index.spec.ts +│   │   │   └── index.ts +│   │   ├── RouterActions.tsx +│   │   └── index.ts +│   └── Styled +│   └── index.tsx +├── static +│   └── images +│   └── pankod-logo.png +├── test +│   ├── Helpers +│   │   └── render.tsx +│   ├── jest.setup.ts +│   ├── mocks.ts +│   └── tsconfig.jest.json +├── tsconfig.json +├── README.md +├── app.json +├── babel.config.js +├── global.d.ts +├── index.js +├── jest.config.js +├── metro.config.js +├── package-lock.json +├── package.json +├── pankod_cover.jpg +└── yarn.lock + +``` + +## License + +Licensed under the MIT License, Copyright © 2018-present Pankod diff --git a/ios/Podfile.lock b/ios/Podfile.lock index e0a817d..d45bfef 100644 --- a/ios/Podfile.lock +++ b/ios/Podfile.lock @@ -195,7 +195,7 @@ EXTERNAL SOURCES: SPEC CHECKSUMS: Base64: cecfb41a004124895a7bcee567a89bae5a89d49b boost-for-react-native: 39c7adb57c4e60d6c5479dd8623128eb5b3f0f2c - CodePush: fe25db2e24ff1a2fab8b280a9633d9ba520867be + CodePush: d2e54ad42df82a8db65b2d23d8191b950ba945e1 DoubleConversion: 5805e889d232975c086db112ece9ed034df7a0b2 Folly: 30e7936e1c45c08d884aa59369ed951a8e68cf51 glog: 1f3da668190260b06b429bb211bfbee5cd790c28 @@ -217,8 +217,8 @@ SPEC CHECKSUMS: React-RCTText: b074d89033583d4f2eb5faf7ea2db3a13c7553a2 React-RCTVibration: 2105b2e0e2b66a6408fc69a46c8a7fb5b2fdade0 React-RCTWebSocket: cd932a16b7214898b6b7f788c8bddb3637246ac4 - RNBootSplash: 87bca176649988833fdea46913ad0301be826c13 - RNCAsyncStorage: 621bad7a889b5bf1583a52547f2dcd3a4d1ff15e + RNBootSplash: 5f3b37a7691ec123b67663ce706bfbbf52f11c8f + RNCAsyncStorage: 2e2e3feb9bdadc752a026703d8c4065ca912e75a RNGestureHandler: 4cb47a93019c1a201df2644413a0a1569a51c8aa RNReanimated: 1b52415c4302f198cb581282a0166690bad62c43 RNScreens: 402a99b0a27c0c32f079cec12d3ccbd35e20cd7f diff --git a/pankod_cover.jpg b/pankod_cover.jpg new file mode 100755 index 0000000..931f918 Binary files /dev/null and b/pankod_cover.jpg differ