generator-wolmo-bootstrap-rn

Wolmo Bootstrap: React Native

Prerequisites

• CocoaPods: https://guides.cocoapods.org/using/getting-started.html#installation
• Node: https://github.com/creationix/nvm#install-script
• React Native Environment: https://facebook.github.io/react-native/docs/getting-started.html
• Ruby (for Fastlane): https://rvm.io/rvm/install
• Yarn: https://yarnpkg.com/lang/en/docs/install/#alternatives-tab

TL;DR

You don't need to clone this repository. Just run the following in your terminal:

bash <(curl -s https://raw.githubusercontent.com/Wolox/wolmo-bootstrap-react-native/master/run.sh)

Description

This codebase is meant to be used to kickoff react native projects with Wolox's tech stack, tools and basic boilerplate. The following optional features can be added out of the box to the new projects:

• Bitrise
• Drawer
• Firebase Analytics
• Firebase Crashlytics
• Firebase Performance
• Firebase Push Notifications
• Login and SignUp
• OnBoarding
• Redux Persist
• Tabs

Boilerplate

The boilerplate includes

• Analytics Tracking
• Basic constants
• Basic utils
• Bitrise configuration
• Deploy configuration with Fastlane Mobile (Android and iOS)
• Font customization
• Formik: HOC to create Custom Fields
• Http client configuration
• i18next configuration
• Push Notifications configuration
• React Navigation: Routes configuration
• Reactotron configuration
• Redux store intialization
• Splash Screen
• TypeScript basic interfaces
• TypeScript configuration

Tech Stack

• Apisauce
• Cerealizr
• Formik
• i18next
• React
• React Native
• React Native Config
• React Native Firebase
• React Native Push Notifications
• React Native Swiper
• React Navigation
• React Redux
• Redux
• Redux Persist
• Redux Recompose
• Redux Thunk
• Reselect
• Seamless Immutable

Tooling

• Babel
• Bitrise
• Eslint
• Fastlane Mobile
• Flipper
• Jest
• Prettier
• React Native Testing Library
• Reactotron
• TypeScript

Bootstrap Kick off

For bootstraping your own project using the template generator script you'll need to follow these steps:

1. Run yarn install.
2. run yo yourPathToWolmo/generators/app/index.js you'll need Yeoman installed for this. Also, the argument -v can be used for logging.
3. Some prompts will pop up on your terminal. Pick whatever configuration works best for your current proyect.
4. After the script is finished, your project folder will be successfully generated with all the necessary yarn dependencies installed. Do cd you/project/path.
5. Start budler using yarn start.
6. Run react-native run-ios --scheme qa or yarn ios for iOS and react-native run-android --variant=qaDebug or yarn android for Android.
7. Start working on your project!

How do you have to configure Bitrise?

You will have to complete the bitriseInfo.json with the next Info:

    "repositoryUrlSsh": "", // What's your repository url? (ssh only)
    "publicApp": false, // If true then the app visibility setting will be public, in case of false it will be private (boolean value)
    "repositorySlug": "", // Write the repo slug (The name of your repo not the url)
    "repoOwner": "", // Who is the owner of the repo?
    "gitProvider": "", // The git provider you are using, it can be 'github', 'bitbucket', 'gitlab', 'gitlab-self-hosted' or 'custom'
    "gitToken": "", // Please, write your git token (github, gitlab ot bitbucket) with permissions to create ssh keys here (write it with the format 'token <access_token>' if it is github, 'Bearer <access_token>' if it's gitlab or bitbucket)
    "bitriseToken": "", // Please, write your bitrise token with permissions to create ssh keys here
    "bitriseOrganizationSlug": "", // Please, write your Bitrise organization slug
    "projectPath": "", // projectPath in case that you want to add the bitrise.yml file to your local repository. This param is in case that you run the script without running the bootstrap
    "projectName": "" // Project name to complete the bitrise.yml file with correct info. This param is in case that you run the script without running the bootstrap

To run only the bitrise script you have to run: yo yourPathToWolmo/generators/bitrise/bitrise.js you'll need Yeoman

Contributing

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create new Pull Request.

About

This project was written by Wolox. It is mantained by:

.

License

wolmo-bootstrap-react-native is available under the MIT license.

Copyright © 2020. WOLOX. All rights reserved. <[e-mail]>

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.

Changelog

[1.3.0] - 2020-09-02

• Replaced Enzyme with RNTL
• Fixed Auth tests
• Updated some Firebase configuration (App, Crashlytics and Performance) in Android and iOS projects
• Disabled R8 for Android releases (multidex overhead memory issue)
• Updated README with Firebase configuration and deployment sections