Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Jay-byte389/AMS/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through everything you need to get AMS running locally — from cloning the repository to seeing the app live on an Android emulator or iOS simulator. The whole process typically takes less than five minutes on a machine that already has the React Native environment set up.
1

Clone the Repository

Clone the AMS repository from GitHub and navigate into the project directory:
git clone https://github.com/Jay-byte389/AMS.git && cd AMS
2

Install JavaScript Dependencies

Install all Node.js dependencies listed in package.json:
npm install
3

Install CocoaPods (iOS Only)

On the first clone — or any time you add or update native dependencies — you must install CocoaPods for iOS. Skip this step entirely if you are targeting Android only.Install the Ruby bundler gems (run once per machine):
bundle install
Then install the CocoaPods dependencies (run on first clone and after any native dependency change):
bundle exec pod install
For more information, see the CocoaPods Getting Started guide.
4

Start the Metro Bundler

Start the Metro JavaScript bundler in a dedicated terminal window. Keep this terminal open while you develop:
npm start
Metro watches your source files and serves the JavaScript bundle to the running app.
5

Run the App

With Metro running, open a second terminal and launch the app on your target platform:
npm run android
This compiles the Android app and installs it on a connected device or running emulator. Make sure Android Studio and an AVD (Android Virtual Device) are set up, or a physical device is connected via USB with USB debugging enabled.
If everything is set up correctly, you will see the AMS splash screen followed by the Register screen.
Fast Refresh is enabled by default. Any time you save a source file, the app automatically updates and reflects your changes without a full rebuild. This is powered by React Native’s Fast Refresh system.
Opening the Developer Menu lets you access debugging tools, reload the bundle, and toggle performance overlays:
  • Android — press Ctrl+M (Windows/Linux) or Cmd+M (macOS) in the emulator window
  • iOS Simulator — press R in the simulator to force a reload

​
Running Tests

AMS uses Jest for unit testing. Run the full test suite with: 
npm test
Jest is configured via the @react-native/babel-preset and picks up any *.test.ts / *.test.tsx / *.spec.js files in the project.

​
Running the Linter

AMS uses ESLint with the @react-native/eslint-config ruleset. Check the entire codebase for lint errors with: 
npm run lint
Fix auto-correctable issues by appending the --fix flag: 
npx eslint . --fix

Build docs developers (and LLMs) love

Get started for freeTalk to us