Setup Environment

This project is developed with React Native CLI using TypeScript.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js (v18 or newer): Download Node.js
• npm (v10.7 or newer): Download npm
• Java Development Kit (JDK) - v17: Download JDK
• Android development environment: See Setup Android Development Environment
• Watchman: Install Watchman (Optional)

For detailed instructions, refer to the React Native documentation.

Setup Android Development Environment

1. Install Android Studio: Download Android Studio
2. Install Android SDK (v14 - UpsideDownCake - API level 34):
   • Open Android Studio
   • Go to SDK Manager
   • Install Android SDK version 14 (UpsideDownCake)

For more information, refer to the React Native documentation.

Preparing the Android device

To run this React Native app, you'll need an Android device. You can use either a physical device or an Android Virtual Device (emulator).

1. Using a Physical Device

   1. Connect your Android device to your computer via USB.
   2. Enable Developer Options on your device:
      • Go to Settings > About Phone.
      • Tap Build Number seven times to enable Developer Options.
   3. Turn on USB Debugging:
      • Go to Settings > Developer Options.
      • Toggle on USB Debugging.

   For more detailed instructions, visit the React Native documentation.

2. Using Emulator

   • Follow the steps below to set up an Android Virtual Device (AVD) emulator:

     1. Open Android Studio.
     2. Go to More Actions.
     3. Select Virtual Device Manager.
     4. Click on Create Virtual Device.
     5. Choose a device definition and click Next.
     6. Select a system image (recommended API Level 34) and click Next.
     7. Configure the AVD options and click Finish.

   Once the emulator is set up, you can launch it and run your React Native app.

   For more detailed instructions, visit the Android Developer documentation.

Running the Application

To run the application, follow these steps:

• Step 1: Install the dependencies by running npm i.
• Step 2: Start the development server with npm start. (If you want to start with a clean cache, run npm start -- --reset-cache.)
• Step 3: Open the application in Android by pressing 'a' (either in an emulator or on a physical device).
• Step 4: Once the terminal displays "Build Successful," the application is running.

Contribution Guidance

To contribute to the project, please follow these steps:

1. Create a New Branch: Create a new branch with a name that describes the issue you are addressing.

2. Work on the Issue: Make the necessary modifications to the code to address the issue.

3. Submit a Pull Request: Once you have completed your work, submit a pull request to merge your changes into the main repository.

Please Refer to this manual for code details and structure: https://github.com/IMS-IIITH/wiki/wiki/

Deployment (Only for Admins)

1. Navigate to the android folder.
2. Execute the command: ./gradlew assembleRelease.
3. Locate the generated APK file at: android/app/build/outputs/apk/release/app-release.apk.

Note: Ensure to update the versionCode and versionNumber in android/app/build.gradle for version Releases.