System Manual

Backend

Requirements

• Docker (available here)
• docker-compose (available here)
• git (available here)
• The provided .env file of the backend.

Steps to Build and Run

• Run the following on the command line:

1. git clone https://github.com/bounswe/2021SpringGroup9
2. cd postory/backend
3. Copy the provided .env file of the backend to the directory
4. docker-compose build
5. docker-compose up -d

After running these commands, the backend will be available at: http://localhost:8000/.

More information on how to run locally and deploy the app can be found in backend/README.md.

Frontend

Requirements

• Docker (available here)
• docker-compose (available here)
• git (available here)
• The provided .env file of the frontend.
• Change the REACT_APP_BACKEND_API variable on the .env file if needed.

Steps to Build and Run

• Run the following on the command line:

1. Clone the repo if not cloned already
   git clone https://github.com/bounswe/2021SpringGroup9
2. cd postory/frontend
3. Copy the provided .env file of the frontend to the frontend directory (2021SpringGroup9/postory/frontend)
4. docker-compose build
5. docker-compose up -d

After running these commands, the frontend will be available at: http://localhost:3000/. You can also access the readme file at https://github.com/bounswe/2021SpringGroup9/tree/master/postory/frontend.

Android

This manual is a guide for running the Postory Android APK. APK is a file format that is used for distribution of Android applications. Our apk is located at 2021SpringGroup9/postory/android/postory.apk on master branch.

Requirements

• Android Studio
• Android Studio AVD Manager

Clone the Code and APK

1. Clone the repo if not cloned already
   git clone https://github.com/bounswe/2021SpringGroup9
2. cd postory/android
3. The apk is named postory.apk

Run on your Android smartphone

The apk file should be transferred to your smartphone. This could be done with a USB connection. After the transfer, click on the APK file on your phone. Defaultly, Android smartphones do not install apk files for security reasons.

• If your Android version is recent, it might prompt you to permit installation of unknown apps. After you allow it, the application will be installed and opened.

• If you are not prompted for giving permissions to unknown apps, you may need to do it manually.

  1- Go to Settings -> Security -> Install Unknown Apps 2- Allow installation of unknown apps.

Note: The steps for giving manual permissions may vary among devices. This is a summary of the process.

Run on Emulator

To run an APK on emulator, you need to have Android Studio along with AVD Manager. To see the formal documentation, click here.

After the AVD Manager is successfully installed, an emulator device should be created (or you can use another emulator that you created before)

To create an emulator(you can skip if you have a suitable emulator):

1- Click on AVD Manager

2- Click on Create Virtual Device

3- Pick a device size. Note that the application works best on smartphone ratios.

4- Select a system image. You need to download the image if it does not exist in your system. This might take some time. Note that you should pick an API level in accordance with the limitations stated in README. A higher API level is usually better but you might need to download more data.

After you have a suitable emulator, run the emulator.

1- Open AVD Manager

2- Run the emulator you want.

3- After the emulator is on, drag and drop the apk file onto its screen.

4- The application might start running or you might need to click on the application at the emulator to run it.

For detailed documentation, click here.