System Manual - bounswe/2021SpringGroup7 GitHub Wiki

System Manual

Minimum Requirements for Building and Running

To be able to build the frontend and backend files Docker* support is necessary with the following minimum requirements:

  • Docker version >= 20.10.6
  • Docker compose version = 3.8
  • Min. of 4GB memory to build the docker images
  • Min. of 1GB memory to run the docker images

Minimum Requirements for Frontend

The frontend supports these browsers:

  • The version usage is above 0.2% versions of browsers are supported
  • The opera mini and dead versions of browsers are not supported.
  • More information about the browser usages can be found here

Building the Images

To build the application, please follow the below steps:

  1. Make sure that Docker is installed in the computer. If not please follow the instructions on their website.
  2. Go to the directory Columbus in the source code of the repository
  3. Go to the Frontend directory
  4. Change the REACT_APP_API_URL in the .env file to where the backend will be deployed with port 8000.
  5. For linux, run the command in the Columbus directory echo "MAIL=Columbus_451_columbus\nDEBUG=True\n" > backend/src/.env to set the run environment for the backend.
  6. Run the following command to build the images for backend and frontend. If you have not enabled the using docker without sudo add the sudo prefix for each command:
    • For Linux: docker-compose build
    • For other OSs: docker compose build
    • If you want to build the specific image specify the service name in the docker-compose file:
      • For backend: docker-compose build backend
      • For frontend: docker-compose build frontend
  7. The backend and frontend images should start the build

Running the Images

Run the built images by running the following commands, you can also use -d command to start the containers at detach state:

  • For linux: docker-compose up
  • For otherOSs: docker compose up
  • For only one of the services use the following commands:
    • For backend: docker-compose up backend
    • For frontend: docker-compose up frontend

Accessing the Running Images

You can access the frontend with HTTP at the deployed URL and the backend at 8000 port at the deployed URL

MOBILE APPLICATION (ANDROID)

Requirements

Environment

  • Android Studio

  • Android SDK

    • minSdkVersion = 21
    • compileSdkVersion = 30
    • targetSdkVersion = 30

  • You can use Android Studio to install SDK by selecting checkboxes while installing it. After that you should set environment variables:

    • Get Android SDK directory on SDK Manager of Android Studio
      1. "Preferences" dialog, under Appearance & Behavior → System Settings → Android SDK.
      2. Configure the ANDROID_HOME environment variable as directory of SDK or c.
      3. You can also create a “local.properties” file in the directory: “Columbus/mobile/Columbus/android/”. Then place code below:
        sdk.dir=export ANDROID_HOME= path to ANDROID_SDK_HOME
      4. If you want to use emulator you should add another environment variable:
        %LOCALAPPDATA%\Android\Sdk\platform-tools

Node

On Windows:

  • You can install it via Chocolatey (package manager system) by running following command:
    choco install nodejs as Administrator Command Prompt.

On Mac OS:

brew install node
brew install watchman via Homebrew package manager system

  • Java Development Kit

    • 1.8

  • npm (Node package manager) or Yarn

    • 8.1.0 (npm)
    • 1.22.17 (yarn)

  • react-native-cli

    • yarn add react-native-cli or
    • npm i react-native-cli

You can look at these web page for any trouble:

To RUN:

  1. yarn or npm install in directory: Columbus/mobile/Columbus
  2. react-native run-android or yarn android

Also You can find APK here: https://github.com/bounswe/2021SpringGroup7/blob/CM-37/Columbus/mobile/app-release.apk You can directly install it to your Mobile Phone or Emulator.