Skip to content

Latest commit

 

History

History
executable file
·
87 lines (62 loc) · 4.44 KB

README.md

File metadata and controls

executable file
·
87 lines (62 loc) · 4.44 KB
Raw

Beacon

Flutter CI

About the Project

This project is a flutter build native interface to ease the group travelling (or hiking). By using this, the group leader would be able to share his location with the entire crew, and in case if someone loses contact with the group, he can quickly get in the right place by following the beacon.

Getting Started

You can test Beacon in your own development environment. This section shows you how:

Prerequisites

You'll need to set up the IDE and mobile device emulator, or any mobile testing device on your local system.

Flutter Environment: You'll need to have the following installed:

  1. Flutter SDK
  2. Android Studio

Ensure you are testing the app using Flutter version 3.0.1 and above.

For checking flutter version:

  • Run flutter --version in terminal

If your version is not upto date, follow these steps to upgrade:

  • flutter channel stable to switch to the channel having stable version of flutter updates
  • flutter upgrade to get the latest flutter version

Development Environment: For setting up the development environment, follow the steps given below.

  • Clone this repository after forking using git clone https://github.com/<username>/beacon.git
  • cd into beacon
  • Check for flutter setup and connected devices using flutter doctor
  • Get all the dependencies using flutter pub get
  • Create a .env file in the root folder, copy the content from .env.example and add respected key's value
  • Run the app using flutter run

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Project Structure

This project follows MVVM architecture with following structure:

beacon/lib/
├── components/                             # Shared Components such as dialog boxes, button, and other shared widgets
├── enums/                                  # enum files
|   └── view_state.dart                     # defines view states i.e Idle, Busy, Error
├── models/                                 # model classes: group, beacon, location, landmark, user
├── queries/                                # includes all graphql query strings
├── services/                               # services
|   ├── database_mutation_function.dart/    # Graphql Queries implementations
|   ├── navigation_service.dart/            # All required navigation services
|   └── ...                                 # all config files
├── utilities/                              # Utilities that includes constants file
├── views/                                  # Views/UI layer
|  ├── auth_screen.dart
|  ├── base_view.dart
|  ├── hike_screen.dart
|  ├── group_screen.dart
|  ├── home.dart
├── viewmodels/                             # Viewmodels layer
├── splash_screen.dart                      # Very first screen displayed whilst data is loading
├── router.dart                             # All routes to ease navigation
├── locator.dart                            # dependency injection using get_it
├── main.dart                               # <3 of the app

Screenshots

Contributing

Whether you have some feauture requests/ideas, code improvements, refactoring, performance improvements, help is always Welcome. The more is done, better it gets.

If you found any bugs, consider opening an issue.

To know the details about features implemented till Google Summer of Code'21 and future todo's please visit this blog

Community

We would love to hear from you! You may join gsoc-beacon channel of CCExtractor community through slack:

Slack