README-project.md

Mobile App

This Project is based on Rootstrap React Native Template

Requirements

• React Native dev environment
• Node.js (version specified in .nvmrc)
• Git
• Watchman, required only for macOS or Linux users
• Pnpm
• Cursor or VS Code Editor ⚠️ Make sure to install all recommended extension from .vscode/extensions.json

Node.js Version Management

This project uses a .nvmrc file to specify the recommended Node.js version. We recommend using a Node.js version manager such as fnm or nvm to ensure you're using the correct version:

With fnm:

fnm install
fnm use

With nvm:

nvm install
nvm use

The version manager will automatically read the .nvmrc file and switch to the correct Node.js version.

👋 Quick start

Clone the repo to your machine and install deps :

git clone https://github.com/user/repo-name

cd ./repo-name

pnpm install

To run the app on ios

pnpm ios

To run the app on Android

pnpm android

To build your app locally you can run any of the build scripts with --local.

pnpm build:development:ios --local

SonarQube setup

SonarQube is an open-source platform for continuous inspection of code quality. It performs automatic reviews to detect bugs, code smells, and security vulnerabilities. Rootstrap has a SonarQube instance to improve the quality of the software we develop. On each PR, a GitHub Action is triggered to perform the analysis. To set up SonarQube correctly, you need to add the SONAR_TOKEN, SONAR_URL, and SONAR_PROJECT secrets to the repository. Additionally, you must select the quality gate named ReactNativeTemplate for your project on SonarQube. In case you're using this project outside Rootstrap and you're not planning to use SonarQube the sonar scanner workflow should be deleted.

✍️ Documentation

• Rules and Conventions
• Project structure
• Environment vars and config
• UI and Theming
• Components
• Forms
• Data fetching
• Contribute to starter
• Distribute using EAS