Skip to content

saigontechnology/rn-base-project-typescript

Repository files navigation


Markdownify
Template Typescript

This project is a template for React Native that can be used to build mobile application.

MIT

RequirementsQuick StartFeaturesDependenciesDocumentsScriptsContributorsAbout UsMissionHistoryContact UsLicense

Requirements

NodeJS (version 16 or later) and NPM is required. To make sure you have them available on your machine, try running the following command

$ npm -v && node -v
9.2.0
v16.19.0

Note You also need to install the dependencies required by React Native.
Go to the React Native environment setup, then select React Native CLI Quickstart tab.
Follow instructions for your given development OS and target OS.

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Quick Start

  1. Init project

    npx react-native init YourProjectName --template rn-base-project-ts
  2. Install node_modules

    yarn install

    Note Pod install automatically after run yarn install

  3. Run Android or Ios via package.json

    # Run android
    yarn android
    
    # Run ios
    yarn ios

⭐ Features

  • 🎉 Provide scripts that perform various tasks, such as building the project, generate files, starting the development server and more.
  • 💅 Integrate in-app debug menu that help you to get the information of device, environment, bundleId, version,... and also allow you to change environment directly in your app.
  • ⚙️ Support for multiple environment builds, including Production, Staging, and Development.
  • 🦊 Husky for Git Hooks, to automate your git hooks and enforce code standards.
  • 💡 State management with Redux Toolkit along with Redux Saga.
  • 🚫 Lint-staged to ensure that your code is always up to standards.
  • ☂️ Pre-installed React Navigation to provide a comprehensive navigation solution for your app.
  • 💫 @react-native-async-storage/async-storage as a storage solution to save sensitive data.
  • 🛠 A simple workflow for building, releasing, and distributing your app using fastlane.
  • 🔥 axios for fetching data, to help you build efficient and performant apps.
  • 🧵 CodePush to deploy mobile app updates directly to their users’ devices.
  • 🎯 Localization with i18n-js.

Dependencies

Our template is ship with the following rock-solid technical decisions out of the box:

Library Category Version Description
React Native Mobile Framework v0.70 The best cross-platform mobile framework
React UI Framework v18 The most popular UI framework in the world
React Native Code Push CI/CD v7 Easily add a dynamic update experience to your React Native app
React Native Config ENV Configuration v18 The most popular UI framework in the world
React Navigation Navigation v1 Expose config variables to your javascript code
i18n-js Translation v4 Provide the i18n translations on the JavaScript
RN Reanimated Animations v2 Beautiful and performant animations
Async-storage Persistence v1 State persistence
React Native SVG SVG Image v13 Provides SVG support to React Native
Axios Network Services v1 Provides promise based HTTP client
Redux / Redux-toolkit State Management v8 Provides state container for JavaScript apps
Redux Saga Redux side-effect v1 Provides Redux side effect manager
ESLint Code Formater v8 Tool for identifying and reporting on patterns Javascript
Jest Test Runner v26 Standard test runner for JS apps
Husky Native Git Hook v8 Improves your commits and more testing

Documents

Scripts

Script Description Syntax
Generate images Get all images from src/assets/images and require images in src/themes/images yarn generateimages
Run App Run app in Android or iOS with selected variants yarn android
yarn ios

Contributors ✨

Thanks goes to these wonderful people

Hong Hoang
Hong Hoang

Huy Do
Huy Do

Bao Nguyenh
Bao Nguyenh

Phi Tran
Phi Tran

Chung Nguyenh
Chung Nguyenh

Vu NguyenDH
Vu NguyenDH

Anh Lehoang
Anh Lehoang

Thinh Vo
Thinh Vo

Loc NguyenT
Loc NguyenT

Hoang Dinh Tien
Hoang Dinh Tien

Loi Do
Loi Do

Huy Duong
Huy Duong

Hang Nguyen
Hang Nguyen

Tung Le
Tung Le

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate. This project follows the all-contributors specification. Contributions of any kind welcome!

About Us

Welcome to Awesome Library! We're a small team of developers passionate about creating library that make people's lives easier.

Mission

Our mission is to create the best library for implementing project stucture easily. We believe that everyone can benefit from tools that help them work smarter, not harder. We're committed to building an library that's easy to use, reliable, and affordable for everyone.

History

My library was founded on Oct 2022 with the goal of making productivity library more accessible to everyone. Since then, we've been working tirelessly to improve the library and add new features.

Contact Us

If you have any questions or feedback, we'd love to hear from you! You can reach us at reactnativeststeam@gmail.com

License

MIT