README.md

Anseo Transit

---

View Demo · Documentation

---

📔 Table of Contents

• Features
• Getting Started
• Screenshots
  • Authentication
  • Home
  • Ticket
  • Plan Route
  • Real Time
  • Available Seats
• Directory Structure
• System Design
  • Methodology
  • Three Tier Architecture
  • Database
  • USE Case
  • Colour Scheme
• Plugins
• Development Process

---

🎯 Features

• Integrated Account Based Ticketing
• View Available Seating on board a fleet
• Real Time Information on multiple modes of public transportation
• Determine optimal route between two locations using multiple modes of transportation

---

🧰 Getting Started

Have a look at the documentation here to get started.

---

📱 Screenshots

1️⃣ Authentication

Splash Screen	Walkthrough	Walkthrough

Walkthrough	Walkthrough	Landing Page

Sign In	Sign Up	Sign Up

2️⃣ Home

Sign In	Sign Up	Sign Up

3️⃣ Ticket

Ticket Overview	Travel Card Overview	Add Travel Card or Ticket Option

Add Travel Card	Add Ticket	Add Ticket

Add Ticket	Use Travel Card or Ticket QR Code	Delete Travel Card

Top Up Travel Card	Top Up Travel Card	Top Up Travel Card

Balance	Activity

4️⃣ Plan Route

Plan Route	Plan Route	Plan Route	Plan Route

5️⃣ Real Time

Real Time Options	Search by Stop Number	Search by Stop Number

Search by Stop Address	Search by Stop Address	Search by Map

Search by Map	Real Time Results

6️⃣ Available Seats

Search by Map

---

📁 Directory Structure

Anseo Transit

|-- lib
|   |-- config
|   |   |-- extensions.dart
|   |   '-- theme.dart
|   |-- model
|   |   |-- map_marker.dart
|   |   |-- real_time_information.dart
|   |   |-- record.dart
|   |   |-- search_direction.dart
|   |   |-- search_routes.dart
|   |   |-- search_stop.dart
|   |   |-- ticket.dart
|   |   |-- transactions.dart
|   |   |-- travel_card.dart
|   |   '-- user.dart
|   |-- pages
|   |   |-- authentication
|   |   |   |-- landing_page.dart
|   |   |   |-- sign_in.dart
|   |   |   '-- sign_up.dart
|   |   |-- help
|   |   |   '-- help.dart
|   |   |-- home
|   |   |   |-- home.dart
|   |   |   |-- root_navigation.dart
|   |   |   '-- user_account.dart
|   |   |-- plan_route
|   |   |   '-- plan_route.dart
|   |   |-- real_time
|   |   |   |-- available_seats.dart
|   |   |   |-- real_time_results.dart
|   |   |   |-- real_time.dart
|   |   |   |-- route_direction.dart
|   |   |   |-- route_stops.dart
|   |   |   |-- search_by_route.dart
|   |   |   |-- search_by_stop_address.dart
|   |   |   |-- search_by_stop_number.dart
|   |   |   '-- search_on_map.dart
|   |   |-- ticket
|   |   |   |-- activity.dart
|   |   |   |-- add_ticket.dart
|   |   |   |-- add_travel_card_ticket.dart
|   |   |   |-- add_travel_card.dart
|   |   |   |-- balance.dart
|   |   |   |-- capping.dart
|   |   |   |-- ticket_overview.dart
|   |   |   |-- top_up_travel_card.dart
|   |   |   '-- use_travel_card_ticket.dart
|   |   |-- walkthough
|   |   |   '-- walkthrough.dart
|   |   '-- firebase_wrapper.dart
|   |-- providers
|   |   '-- walkthrough_provider.dart
|   |-- services
|   |   |-- aes_encryption.dart
|   |   |-- firebase_auth.dart
|   |   '-- firebase_database.dart
|   |-- widgets
|   |   |-- available_seat.dart
|   |   |-- colour_type.dart
|   |   |-- ndef_record.dart
|   |   |-- unavailable_seat.dart
|   |   |-- walkthrough_progress_indicator.dart
|   |   '-- walkthrough_template.dart
|   '-- main.dart
|-- assets
|   |-- gtfs
|   |   |-- routes
|   |   |   |-- dublinBusRoutes.json
|   |   |   |-- goAheadRoutes.json
|   |   |   |-- iarnrodEireannRoutes.json
|   |   |   '-- luasRoutes.json
|   |   |-- stops
|   |   |   |-- dublinBusStops.json
|   |   |   |-- goAheadStops.json
|   |   |   |-- iarnrodEireannStops.json
|   |   |   '-- luasStops.json
|   |   |-- trips
|   |   |   |-- dublinBusTrips.json
|   |   |   |-- goAheadTrips.json
|   |   |   |-- iarnrodEireannTrips.json
|   |   |   '-- luasTrips.json
|   |   |-- extensions.dart
|   |   '-- theme.dart
|   |-- icons
|   |   |-- account.png
|   |   |-- activity.png
|   |   |-- add.png
|   |   |-- address.png
|   |   |-- adult.png
|   |   |-- back.png
|   |   |-- balance.png
|   |   |-- capping.png
|   |   |-- child.png
|   |   |-- delete.png
|   |   |-- forward.png
|   |   |-- journey_planner.png
|   |   |-- map_marker.png
|   |   |-- numbers.png
|   |   |-- real_time.png
|   |   |-- route.png
|   |   |-- seat.png
|   |   |-- stop.png
|   |   |-- ticket.png
|   |   |-- top_up.png
|   |   |-- travel_card.png
|   |   |-- use.png
|   |   '-- verified.png
|   |-- logo
|   |   '-- logo1_500.png
|   '-- theme.dart
|-- functions
|   '-- index.js
|-- available_seats.py
|-- pubspec.yaml

---

📐 System Design

🚥 Methodology

Feature Driven Development (FDD), a part of the Agile Methodology, organizes software development around making progress on features in a systematically manner. This was the chosen methodology used in this application as FDD supports the dynamic evolvement of a feature including the inclusion and/or removal of designs and code, and the overall direction of the project.

Given how this project has multiple features to develop, it will allow for each feature to be developed thoroughly with a specific timeframe using sub-features.

To compensate for the potential decrease in documentation, a daily log with all the progress made regarding each feature will be written out whenever a development is being carried out.

Using GitHub as the choice for version control will also provide documentation on any changes that has occurred.

---

🏢 Three Tier Architecture

Anseo Transit is build upon a three-tier architecture model, as show above. With three-tier architecture, it's advantageous in that any changes made to one tier shouldn’t affect any other tiers in theory. The diagram shows the entities within each layer

---

💿 Database

Firebase Cloud Firestore, a NoSQL database, will be implemented to store user, travel card and ticket information. The following Entity Relationship Diagram highlight the fields necessary to create the database.

---

🎭 USE Case

Use Case Diagrams were created to represent the how the system would behave in line with the users interaction. It demonstrates the compulsory and extendable functionality that is applicable to the user when interacting with the system. In this case there is three actors – the commuter, the bus driver/operator and the admin. Each actor has access to certain functionalities and may share common functionalities with other actors.

---

🎨 Colour Scheme

Main Application

Color	Hex
Primary Color	#673AB7
Secondary Color	#9575CD
Background Color	#FFFFFF
Accent Color	#9FA8DA
Icon Gradient	#1A6DFF #C822FF
Text Color	#000000

---

Travel Cards

Color	Hex	Result
Student Travel Card	#4158D0 #C850C0 #FFCC70
Adult Travel Card	#0061FF #60EFFF
Child Travel Card	#8EC5FC #E0C3FC

---

Logo

Colour	Result
Color Hex Logo Background #4158D0 #C850C0 Logo Text #FFFFFF

---

🔌 Plugins

Name	Version	Usage
firebase_core	^1.12.0	Enables connecting to multiple Firebase apps
firebase_auth	^3.3.6	Enabling Android and iOS authentication using passwords, phone numbers and identity providers like Google, Facebook and Twitter
cloud_firestore	^3.1.7	Use the Cloud Firestore API a cloud-hosted, noSQL database with live synchronization
provider	^6.0.2	Dependency injection and state management
qr_flutter	^4.0.0	QR code rendering
encrypt	^5.0.1	Generate cryptographically secure random keys and IVs
carousel_slider	^4.0.0	Carousel slider widget
http	^0.13.4	API for HTTP requests
flutter_stripe	^2.2.0	API for Stripe Payments
sweetsheet	^0.3.1	Show beautiful bottom sheet as confirmation dialog
numberpicker	^2.1.1	Widget allowing user to choose numbers by scrolling spinners.
nfc_manager	^3.1.1	Accessing the NFC features on Android and iOS
latlong2	^0.8.1	Library for common latitude and longitude calculation
flutter_map	^0.14.0	Mapping package based off leaflet.js
global_configuration	^2.0.0-nullsafety.1	Managing different configurations and making them available everythere inside the app
google_fonts	^2.3.1	Use fonts from fonts.google.com
flutter_native_splash	^2.1.2+1	Customize Flutter's default white native splash screen with background color and splash image
curved_navigation_bar	^1.0.3	Implementation of curved navigation bar
url_launcher	^6.0.20	Launching a URL
flutter_map_marker_cluster	^0.4.4	Provides beautiful animated marker clustering functionality for flutter_map
percent_indicator	^3.4.0	Display progress widgets based on percentage
flutter_launcher_icons	^0.9.2	Updating application launcher icon

---

🚧 Development Process

The documentation process for Anseo Transit can be viewed here