Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 3.35 KB

README.md

File metadata and controls

82 lines (53 loc) · 3.35 KB
Raw

Look For Drinks Template

Made by Marlon Marques

This is a template developed to serve as a basis for the look fo drinks project and also for future projects.

As this project has external dependencies, such as configurations etc. This README is intended to help you configure your template so that everything works correctly. Below you will find some of the features present in the architecture of this project.

  • Assets
  • Services
  • Components
  • Api
  • Navigation
  • Stores
  • Themes
  • Types
  • Utils

Some of the main libraries used: Analytics e Crashlytics (Firebase), Async Storage, Mobx, Styled-Components, Reanimated, Axios, Formik, Yup, Size matters, React Native Config for environment variables, Integration with CodePush and Fastlane, Tests with Detox, Jest and React Native Testing Library etc.

Prerequisites

If you have no idea how to install React Native and run it locally, check this out getting started guide.

If you want to rename the template according to your project, I recommend using React Native Rename.

Also, the project has firebase and codepush dependencies, in case you have no idea where to start, then check below:

  • Firebase

    The project uses Analytics and Crashlytics, you will need to create an account on firebase and create a project. don't forget to configure for Android and IOS, any doubts, check this Getting started, and for specific settings for React Native, follow through this guide.

  • CodePush

    To set up CodePush, you will need to create an appcenter account and configure your environment. To help you, you can follow this Guide.

  • Fastlane

    To make the publishing and releasing process easier, you will need to set up your environment, please check these steps.

Configuration

If you have configured firebase and codepush then you will only need to add some files and variables to the template.

  • Android

    Browse to the root of the project, then browse to the android folder, inside the app folder add the google-services.json file.

    Add your codepush key to CODE_PUSH_KEY_ANDROID in .env.dev and .env.prod files.

  • IOS

    Browse to the root of the project, then browse to the ios folder, add the GoogleService-Info.plist file. It is important to carry out this process through xcode.

    Add your codepush key in CODE_PUSH_KEY_IOS in .env.dev and .env.prod files.

Build

Now the grand finale, at the root of the project, run:

yarn

Then, depending on the platform you want to run the template on, just run:

yarn android
yarn ios

Attention

The other scripts, such as unit tests, e2e test etc. You can find it at package.json.