Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 3.2 KB

README.md

File metadata and controls

68 lines (45 loc) · 3.2 KB

Plant&Go Mobile Application (Flutter)

Production Release

The Plant&Go Project consists of two parts:

  1. Plant&Go Backend Server (Spring Boot MVC)
  2. Plant&Go Mobile Application (Flutter)

Quick Start

Introduction

Plant&Go is a food ordering platform that promotes and incentivises consumers to incorporate environmentally sustainable diets into their daily lives, reducing carbon emission from food consumption

Usage

If you just wish to use the application and don't intend to contribute, you can download pre-built .apk (Android) or .ipa (iOS) file from the releases section of this Github Repository.

Note that the pre-built application uses the Plant&Go Backend Server. This project is a demo application, please do not enter any sensitive or important data on this platform. Data entered on this platform will be wiped periodically.

Overview

Solution Architecture

Database Entity-Relation Diagram

Setup

If you wish to contribute to the project or build your own .apk/.ipa files, please refer to the guides written in the next few sections.

Dependencies

Before getting starting with development or running the application, install the following tools:

  • Git
  • Flutter
  • Android Emulator/iOS Emulator/Mobile Phone

Installation

After installing the above dependencies, make a copy of the repository with the git clone command or download the repository by clicking, Code -> Download Zip on the Github Repository Page.

git clone https://github.com/plantngo/plantngo_mobile

When you're done cloning the project, you will need to cd into the project directory. Open up your terminal and run the following command:

# change directory into the project
cd plantngo_mobile

Running

As this project is a Frontend Application, it's only able to function when referencing the Backend Server built for it.

Self-Hosted Backend Server

If you wish to host the Backend Server yourself, you can refer to the guide on Plant&Go Backend Server's Github Repository on setting up a Plant&Go Backend Server.

To run the mobile application with a Self-Hosted Backend Server, modify and execute the flutter_run.sh bash script provided.

<flutter_run.sh>
# runs the app with the SPRINGBOOT_HOST variable
# change the IP Below to your locally hosted server's ip:port
flutter run --dart-define=SPRINGBOOT_HOST="http://localhost:8080"

Note that if you are using an Android Emulator, you should specify the IP Address of your device instead of localhost. This is because localhost in the Android Emulator's perspective refers to the Emulator's Internal IP Address instead of the Host's IP Address.