System Manual

Bull & Bear System Manual

System Requirements

Minimum Hardware Requirements:

• RAM: 4 GB
• CPU: Dual-core processor
• Storage: 10 GB available disk space

Supported Operating Systems:

• Web Application:
  • Windows 10 or later
  • Mac OS Mojave or later
  • Ubuntu 18.04 or later
• Mobile Application:
  • Android 8.0 (API Level 26) or later

---

Installation Instructions

Running the Application Locally

To run the backend in your local machine, follow the steps below. Make sure you have Docker installed on your system. Also ensure that you can run Docker Compose commands. Then follow these steps:

1. Clone the repository:

   git clone https://github.com/bounswe/bounswe2024group2.git
   cd bounswe2024group2
   

2. Build and start the application:

   docker compose build
   docker compose up -d
   

After setup:

• API: Available at http://localhost:8000
• Annotations Server: Available at http://localhost:8001
• WEB: Available at http://localhost:3000
• MAILHOG: View emails at http://localhost:8025

---

System Manual for Mobile Application Setup

This guide outlines the steps to set up, develop, and build the mobile application using React Native Community CLI.

1. Prerequisites

Ensure the following prerequisites are installed and configured on your system:

1.1 Software Requirements

• Node.js (version 16 or later)
• React Native CLI: Install globally using:

  npm install -g react-native-cli

• Android Studio: Required for Android emulation and SDK tools.
  • Install and configure the Android SDK.
  • Ensure the ANDROID_HOME environment variable is set correctly.

2. Mobile Application Setup

2.1 Clone the Mobile Repository

1. Clone the repository:

   git clone https://github.com/bounswe/bounswe2024group2.git

2. Navigate to the mobile directory:

   cd mobile

3. Switch to the main branch (if not already on it):

   git checkout main

2.2 Install Dependencies

Install the required dependencies for the application:

npm install

3. Running the Application

3.1 Android Emulator Setup

1. Install Android Studio and set up an emulator:

   • Open Android Studio and go to AVD Manager.
   • Create a new emulator with the desired Android version (API Level 30 or higher).
   • Start the emulator.

2. Verify Android SDK path is set:

macOS/Linux

• Add the following to your system's environment variables:

  export ANDROID_HOME=$HOME/Android/Sdk
  export PATH=$PATH:$ANDROID_HOME/emulator:$ANDROID_HOME/tools:$ANDROID_HOME/tools/bin:$ANDROID_HOME/platform-tools

• Apply the changes:

  source ~/.zshrc

Windows

• Open System Properties:
  • Press Win + R, type sysdm.cpl, and hit Enter.
  • Go to the Advanced tab and click on Environment Variables.
• Add a new System Variable:
  • Variable Name: ANDROID_HOME
  • Variable Value: C:\Users\<your-username>\AppData\Local\Android\Sdk
• Edit the Path variable under System Variables:
  • Add the following paths:

    %ANDROID_HOME%\emulator
    %ANDROID_HOME%\tools
    %ANDROID_HOME%\tools\bin
    %ANDROID_HOME%\platform-tools
    

• Save the changes and restart your terminal.

3.2 Start the React Native Development Server

1. Start the development server:

   npx react-native start

2. Once the development server is running, press a in the same terminal.
   This will automatically build and run the app on the connected Android emulator.

3.3 Using a Physical Android Device

1. Enable Developer Mode and USB Debugging on your Android device.
2. Connect the device to your computer using a USB cable.
3. Run the app on your device:

   npx react-native start

4. Press a in the terminal to deploy the app to your connected device.

For further information, please visit https://reactnative.dev/docs/environment-setup

4. Building the APK

To create a standalone APK for the mobile app:

4.1 Generate a Release Build

1. Prepare a Keystore file:

   • Navigate to the android/app directory:

     cd android/app

   • Run the following command to generate a Keystore file:

     keytool -genkey -v -keystore release-key.keystore -keyalg RSA -keysize 2048 -validity 10000 -alias your-key-alias

   • Save the generated release-key.keystore in the android/app directory.

2. Configure the Keystore:

   • Open android/app/build.gradle and add the Keystore information:

     android {
         signingConfigs {
             release {
                 storeFile file('release-key.keystore')
                 storePassword 'your-store-password'
                 keyAlias 'your-key-alias'
                 keyPassword 'your-key-password'
             }
         }
         buildTypes {
             release {
                 signingConfig signingConfigs.release
                 minifyEnabled false
                 shrinkResources false
                 proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
             }
         }
     }

3. Build the APK:

   cd android
   ./gradlew assembleRelease

4. The APK will be located at:

   android/app/build/outputs/apk/release/app-release.apk
   

---