Skip to content

Latest commit

 

History

History
135 lines (95 loc) · 5.88 KB

README.md

File metadata and controls

135 lines (95 loc) · 5.88 KB
Raw


✔️ How to Start

1) Prerequisites

To run any Android application built with Flutter you need to configure the enviroments in your machine, you can do this following the the tutorial provided by Google in Flutter website

  • Flutter SDK
  • Android Studio (to download Android SDK)
  • Xcode (for iOS develop only)
  • Any IDE with Flutter SDK installed (ie. IntelliJ, Android Studio, VSCode etc)
  • A little knowledge of Dart and Flutter

2) Clone

Clone this repo to your local machine using:

git clone https://github.com/Beach-Combine/Mobile.git

3) Setup

Set the your own Google Map Key in android/app/local.properties:

google.map.key = YOUR_GOOGLE_MAP_KEY

To run the app you need to have an online emulator or a plugged device and run the following command in the root of the application.

Android

flutter run

📲 Execution Method

For Android User

  1. Download apk file ⭐ here ⭐. (Available for Android version 12 or higher)
  2. You can use it right away by installing it on your smartphone!
  • Currently, this service is providing beta service for Busan, Korea

Tip

Our service is currently focused on Busan, South Korea. Therefore, we provide a testing feature for customers in inland areas or those who cannot visit Busan to experience the entire cleaning process.

Upon entering the home screen, users will see a Test button. When they press this button, their current location will be moved to the Busan area, allowing them to explore various features. If users move to a different location from their current position, the screen will reflect the corresponding change. Feel free to click on nearby markers to experience different feedback.

Please note that this feature is designed solely for testing purposes and is not reflected in the actual database. Therefore, no rewards will be given upon completing the entire cleaning process. Keep this in mind!

In the actual Busan sea, all features can be used without any issues. Come and enjoy Busan!


⚙️ Release Note

2023-03-31

v1.0.0 release

  • Added Main Feature(Cleaning the beach)
  • Added Community Feature
  • Added Ranking Feature
  • Added Mypage Feature

2023-06-05

v1.1.0 release

  • Added Admin Feature
  • Added Testing Feature
  • Added Notification Feature
  • Added Tutorial Feature

💡 How to use


📽 Demo Video Link

BeachCombine


🏛 Project Architecture


🛠 Tech Stacks


📋 GIT Strategy

1) Git Workflow

main → develop → feature/Issue#-feature, fix/Issue#-feature, refactor/Issue#-feature

  1. Work individually on each branch local - feature/Issue#-feature
  2. After completing the task, submit a PR to remote - develop.
  3. After code review, receive approval and merge
  4. Every time a merge occurs in remote - develop, all team members pull from remote - develop to maintain the latest status

2) Commit Convention

Tag name Description
feat Commits that add a new feature
fix Commits that fix a bug
hotfix Fix an urgent bug in issue or QA
build Commits that affect build components
chore Miscellaneous commits
style Commits for code styling or format
docs Commits that affect documentation only
test Commits that add missing tests or correcting existing tests
refactor Commits for code refactoring

👥 Contributors

Mobile/AI Backend Backend Design
김성겸 권보민 추서연 백송은

📎 Link