This project was developed by Amela Technology

Below you'll find information about performing common tasks.

Table of Contents

• Introduction
• A. Getting started
• B. Available scripts
• C. Common errors
• D. Template folder structures
• E. Document run and deploy
• F. Roadmap

Introduction

• Easy to start
• React-native version 0.73.0
• Fully using typescript for typing
• Folder structure using package-by-feature (why)
• Redux-toolkit, redux-saga, redux-persist, redux-logger
• React-navigation v6
• 100% functional component with hooks
• A lot of custom/base components
• i18next for multiple languages
• Custom hooks for share state logic between components
• Eslint with Prettier plugin for checking code convention
• Husky for pre-commit (we check lint to make sure we have no errors first when commit)
• Amela React-native CLI

A. Getting started

I. Automatically with AMELA-RN-CLI

--To Be Determined--

II. Manually step-by-step method

[!] Note before installation

• NodeJS version must be >= version 18
• Android Studio must be >= version Giraffe
• CocoaPods must be >= version 1.14.0
• Must install patch-package.

Installation

1. Use yarn [Recommended]

• Must installed yarn before.

• npx react-native init your-project-name --template react-native-template-amela --pm yarn --skip-git-init true --install-pods true

  npx react-native init TestProject --template react-native-template-amela --pm yarn --skip-git-init true --install-pods true

2. Use npm

• npx react-native init your-project-name --template react-native-template-amela --skip-git-init true --install-pods true

  npx react-native init TestProject --template react-native-template-amela --skip-git-init true --install-pods true

[!] Note after installation

• Copy all installed files and folders into your GIT project.
• Copy .gitignore file from THIS REPOSITORY into your GIT project (.gitignore is removed while npx react-native init)
• Duplicate file .env.development from folder environment to your root project. Rename to .env https://prnt.sc/K23PXoWJ19tn

Some manual setups

1. ~~Setup react-native config (Amela-style) following guide (deprecated - need upgrade): https://docs.google.com/document/d/1sPg4N7iXEgD_NzbXBRD_SzHPo4p48uJIgG_fC9hK48s |~~
2. Setup modalize following guide: https://jeremybarbet.github.io/react-native-modalize/#/INSTALLATION

B. Available Scripts

If Yarn was installed when the project was initialized, then dependencies will have been installed via Yarn, and you should probably use it to run these commands as well. Unlike dependency installation, command running syntax is identical for Yarn and NPM at the time of this writing.

npm start or yarn start

Runs your app in development mode.

npm start  --reset-cache
# or
yarn start  --reset-cache

npm test or yarn test (in development)

Runs the jest test runner on your tests.

yarn commit

Show list commit types to choose and execute commits (using commit-lint).

C. Common errors

D. Template folder structures

.
├── App.tsx
├── Gemfile
├── Gemfile.lock
├── reactotron.config.js
├── __tests__
│   └── App.test.tsx
├── app.json
├── commitlint.config.js
├── defaultIcon.jpeg
├── environment
├── index.js
├── jest.config.js
├── metro.config.js
├── package.json
├── patches
│   ├── react-native+0.73.0.patch
│   ├── react-native-code-push+8.1.0.patch
│   ├── react-native-image-crop-picker+0.40.2.patch
│   ├── react-native-keyboard-aware-scroll-view+0.9.5.patch
│   └── react-native-size-matters+0.4.2.patch
├── react-native.config.js
├── settings.json
├── src
│   ├── App.tsx
│   ├── api
│   │   ├── interface
│   │   │   ├── authenticate.ts
│   │   │   └── general.ts
│   │   ├── modules
│   │   │   └── api-app
│   │   │       ├── authenticate.ts
│   │   │       ├── general.ts
│   │   │       └── notification.ts
│   │   └── request.ts
│   ├── app-redux
│   │   ├── hooks.ts
│   │   ├── sagas
│   │   │   ├── resourceSaga.ts
│   │   │   ├── rootSaga.ts
│   │   │   └── userInfoSaga.ts
│   │   ├── slices
│   │   │   ├── initSlice.ts
│   │   │   ├── languageSlice.ts
│   │   │   ├── resourceSlice.ts
│   │   │   ├── types.ts
│   │   │   └── userInfoSlice.ts
│   │   └── store.ts
│   ├── assets
│   │   ├── fonts
│   │   │   ├── Montserrat-Light.ttf
│   │   │   ├── Montserrat-Regular.ttf
│   │   │   └── Montserrat-SemiBold.ttf
│   │   ├── icon
│   │   │   ├── ic_account.png
│   │   │   ├── ic_back.png
│   │   │   ├── ic_calendar.png
│   │   │   ├── ic_check_radio.png
│   │   │   ├── ic_check_square.png
│   │   │   ├── ic_home.png
│   │   │   ├── ic_notification.png
│   │   │   ├── ic_select.png
│   │   │   ├── ic_setting.png
│   │   │   ├── ic_uncheck_radio.png
│   │   │   └── ic_uncheck_square.png
│   │   ├── images.ts
│   │   ├── locates
│   │   │   ├── en.ts
│   │   │   └── jp.ts
│   │   ├── metrics.ts
│   │   ├── photo
│   │   │   └── img_default_image.png
│   │   ├── sizes.ts
│   │   └── themes.ts
│   ├── components
│   │   ├── base
│   │   │   ├── AlertMessage.ts
│   │   │   ├── CheckBox.tsx
│   │   │   ├── ProgressiveImage.tsx
│   │   │   ├── StyledButton.tsx
│   │   │   ├── StyledIcon.tsx
│   │   │   ├── StyledImage.tsx
│   │   │   ├── StyledIndicator.tsx
│   │   │   ├── StyledInput.tsx
│   │   │   ├── StyledInputForm.tsx
│   │   │   ├── StyledList.tsx
│   │   │   ├── StyledModalDropdown.tsx
│   │   │   ├── StyledNoData.tsx
│   │   │   ├── StyledOverlayLoading.tsx
│   │   │   ├── StyledSectionList.tsx
│   │   │   ├── StyledText.tsx
│   │   │   ├── StyledTouchable.tsx
│   │   │   ├── StyledWebView.tsx
│   │   │   ├── index.ts
│   │   │   ├── list-view-selected
│   │   │   │   ├── StyledListViewSelected.tsx
│   │   │   │   └── components
│   │   │   │       └── ItemListViewSelected.tsx
│   │   │   ├── modal
│   │   │   │   ├── ModalizeCenterComponent.tsx
│   │   │   │   └── ModalizeManager.tsx
│   │   │   └── picker
│   │   │       ├── StyledDateTimePicker.tsx
│   │   │       └── StyledModalPicker.tsx
│   │   └── common
│   │       ├── CodePushProgressDialog.tsx
│   │       └── StyledHeader.tsx
│   ├── feature
│   │   ├── account
│   │   │   └── AccountScreen.tsx
│   │   ├── authentication
│   │   │   ├── ChangePassword.tsx
│   │   │   ├── ForgotPwdScreen.tsx
│   │   │   ├── LoginScreen.tsx
│   │   │   ├── RegisterScreen.tsx
│   │   │   └── SendOtp.tsx
│   │   ├── chat
│   │   │   └── ChatScreen.tsx
│   │   ├── home
│   │   │   ├── HomeDataScreen.tsx
│   │   │   ├── HomeDetailScreen.tsx
│   │   │   ├── HomeScreen.tsx
│   │   │   ├── HomeUserListScreen.tsx
│   │   │   └── components
│   │   │       ├── ModalContent.tsx
│   │   │       ├── ModalContent2.tsx
│   │   │       └── UserCard.tsx
│   │   ├── notification
│   │   │   └── NotificationScreen.tsx
│   │   └── setting
│   │       └── SettingScreen.tsx
│   ├── hooks
│   │   ├── useApi.ts
│   │   ├── useInput.ts
│   │   ├── usePaging.ts
│   │   └── usePagingTakeAfter.ts
│   ├── navigation
│   │   ├── NavigationService.ts
│   │   ├── components
│   │   │   └── StyledTabBar.tsx
│   │   ├── config
│   │   │   ├── options.ts
│   │   │   ├── routes.ts
│   │   │   └── transition.ts
│   │   └── scene
│   │       ├── AuthScenes.tsx
│   │       ├── RootScenes.tsx
│   │       └── TabScenes.tsx
│   └── utilities
│       ├── CommonInterface.ts
│       ├── SocketProvider.tsx
│       ├── authenticate
│       │   ├── AuthenticateService.ts
│       │   └── TokenProvider.ts
│       ├── enum.ts
│       ├── format.ts
│       ├── helper.ts
│       ├── i18next.ts
│       ├── logger.ts
│       ├── notification
│       │   └── index.ts
│       ├── permissions
│       │   └── index.ts
│       ├── react-i18next.d.ts
│       ├── staticData.ts
│       ├── types
│       │   └── typing.d.ts
│       ├── upload
│       │   ├── ImagePicker.tsx
│       │   └── ImageUploader.ts
│       ├── validate.ts
│       └── yupValidate.ts
├── tsconfig.json
└── yarn.lock

43 directories, 131 files

E. Document run and deploy

Document run and deploy

F. Road-map

• [x] Convert base into react-native-cli template.
• [ ] New way of using react-hook-form.
• [ ] Remove redundant files/folders (maybe create a folder demo that contains all sample UI/components in it).
• [ ] Rename files in folder base, common (maybe remove prefix Styled)
• [ ] Find a way to integrate UI/UX 3rd party.