Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mzdm/virtual_traveller_flutter
Cross-platform Application (Mobile, Web, Desktop): Travel virtually and discover interesting destinations.
https://github.com/mzdm/virtual_traveller_flutter
amadeus android desktop flights flutter flutter-app flutter-apps ios tourism web
Last synced: 19 days ago
JSON representation
Cross-platform Application (Mobile, Web, Desktop): Travel virtually and discover interesting destinations.
- Host: GitHub
- URL: https://github.com/mzdm/virtual_traveller_flutter
- Owner: mzdm
- License: mit
- Created: 2020-09-20T09:16:44.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-20T22:56:02.000Z (over 3 years ago)
- Last Synced: 2024-10-17T07:39:46.815Z (about 1 month ago)
- Topics: amadeus, android, desktop, flights, flutter, flutter-app, flutter-apps, ios, tourism, web
- Language: Dart
- Homepage:
- Size: 7.38 MB
- Stars: 21
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
-- Virtual Traveller --
WIP
APP IS IN THE VERY EARLY DEVELOPMENT PROGRESS - AND DOESN'T REPRESENT THE FINAL STATE
```
# Virtual Traveller
  [](https://codecov.io/gh/mzdm/virtual_traveller_flutter)
Search for flights and deep dive into large offers of travelling destinations. Discover recommended and popular places. Hop on on the virtual mode to simulate travelling immediately to your desired destination and learn more about it, including interesting information and points of interests! 🚀
## Index
- [Previews](https://github.com/mzdm/virtual_traveller_flutter#previews)
- [How to run](https://github.com/mzdm/virtual_traveller_flutter#how-to-run)
- [Idea](https://github.com/mzdm/virtual_traveller_flutter#idea)
- [Visualizing the flow of the app](https://github.com/mzdm/virtual_traveller_flutter#visualizing-the-flow-of-the-app)
- [State management](https://github.com/mzdm/virtual_traveller_flutter#state-management)
- [App Architecture](https://github.com/mzdm/virtual_traveller_flutter#app-architecture)
- [TODO list](https://github.com/mzdm/virtual_traveller_flutter#todo-list)
- [Dependencies](https://github.com/mzdm/virtual_traveller_flutter#dependencies)
- [UI inspirations](https://github.com/mzdm/virtual_traveller_flutter#ui-inspirations)
- [Related recommended resources](https://github.com/mzdm/virtual_traveller_flutter#related-recommended-resources)
- [Credits](https://github.com/mzdm/virtual_traveller_flutter#credits)
- [Contribution](https://github.com/mzdm/virtual_traveller_flutter#contribution)
## Previews
## How to run
1. Clone this repository
2. Fetch packages:
```flutter pub get```
3. - Run freezed and json_serializable code generators:
```flutter pub run build_runner build --delete-conflicting-outputs```
- Automatically rebuild on changes with:
```flutter pub run build_runner watch```
4. - Run on the device:
```flutter run``` (run in Profile mode if you want to test the performance)
- Run on the web (make sure you are on the **beta** channel):
```flutter run -d web```
- Run with flag on the web with better performance (experimental):
```flutter run -d web --release --dart-define=FLUTTER_WEB_USE_SKIA=true```
- Run on the desktop (Windows) (make sure you are on the **dev** channel):
```flutter run -d windows```
**NOTE:** If you want to use remote APIs instead of local fake data, you need to obtain API key(s).
The web preview version uses fake data because it is built from the repository and API keys would get exposed.
[Obtain the Amadeus Travel API key here](https://developers.amadeus.com/get-started/get-started-with-self-service-apis-335).
Then:
- place the key to this file: *lib/data/data_providers/remote/secrets.dart*
- set **quotaSaveMode** to ```false``` in *lib/utils/debug_options.dart*
## Idea
I wanted to make a flight searching app with interesting suggestions, fully from the scratch. However, due to the current situation with the pandemic, many countries are restricted for some citizens so travelling there isn't possible. This app has virtual travelling mode, which simulates the travelling here, displays interesting information about the desired location, including picture, points of interests and etc. There's a possibility to save the locations, so you can check them out later!
Powered by the [Amadeus for Developers API](https://developers.amadeus.com/), which fits best for this use and offers also free monthly quota for testing! Amadeus Travel APIs connect you to the richest information in the travel industry.
## Visualizing the flow of the app
## App Architecture
Using the bloc library allows us to separate our application into three layers:
- Presentation
- Business Logic
- Data
- Repository
- Data Provider
- Models
## State management
There's no unique rule on what to choose because it always depends on many criteria. When it came to deciding on which state management approach to use in my case, I was deciding between Provider and bloc library. Bloc library is already dependant on Provider package so it is fairly similar in terms of a dependency injection (DI) (a single instance of a Cubit or Bloc can be provided to all of the widgets within a subtree). [Read more here about bloc library](https://bloclibrary.dev/#/) and [Provider](https://pub.dev/packages/provider).
The reasons why I decided to use the bloc library in my case were following:
- use of the reactive streams, which goes well together with BLoC pattern
- easy and reliable tests via bloc_test library, which is based on Mockito
- it isn't only a state management library, but it also helps implement the BLoC (Business Logic Component) design pattern
## TODO list
### Basics:
- [ ] Features
- [ ] Splash screen
- [ ] Intro slider on the first app launch
- [ ] Home Page Features
- [x] Change departure location
- [ ] Quick search
- [x] One-Way flights
- [x] Destinations
- [x] Discover most popular / booked travelling destinations based on the current location
- [ ] Recommended destinations based on search history
- [ ] Flight Searching Page Features
- [ ] View search history
- [ ] Search by
- [x] Type of the way
- [x] One-Way
- [x] Round Trip
- [ ] Multi City
- [ ] Dates
- [ ] Departure
- [ ] Return
- [x] Passengers
- [x] Adults
- [x] Kids
- [x] Infants
- [ ] Flight Result Page Features
- [ ] Switch departure and destination in the search
- [ ] Display quick search query info details
- [ ] View more about the destination
- [ ] Sort by
- [ ] Price
- [ ] Length
- [ ] Number of stops
- [ ] Flight offer details
- [ ] From - To
- [ ] Departure - Arrival date
- [ ] Flight length
- [ ] Flight stops
- [ ] Passengers
- [ ] Price
- [ ] Airplane type
- [ ] Virtual Flight Mode
- [ ] Simulate airplane flying on the map with the timestamps
- [ ] Destination Info Page
- [ ] Save destination to the Watchlist
- [ ] Pictures
- [ ] Average temperature of the past week
- [x] Safety Rating
- [x] List nearby Points of Interests Page
- [x] POI Details Page
- [x] GPS Coordinates
- [x] Pictures
- [x] List nearby Hotels Page
- [ ] Hotel Details Page
- [ ] GPS Coordinates
- [ ] Distance from the city center
- [ ] Stars
- [ ] Description
- [ ] Pictures
- [ ] Tags: Amenities (Wi-Fi, TV, ...), Appliances etc.
- [ ] Watchlist Page
- [x] Click to view the info about the destination
- [ ] Drag to reorder destinations
- [ ] Swipe to remove
- [ ] Settings Page
- [ ] Change default departure location
- [ ] Language
- [ ] Currency
- [ ] Temperature format
- [ ] Length unit
- [ ] Theme
- [ ] Remove local data
- [ ] Language Support
- [x] English
- [x] Czech
- [ ] Portuguese
- [ ] Russian
- [ ] Chinese
- [ ] French
- [ ] German
- [x] Supported Platforms
- [x] Mobile (Android & iOS)
- [x] Web
- [x] Desktop
### Other:
- [x] Null safety
- [x] CI / Github Actions
- [x] Type of tests
- [x] Unit
- [x] Widget
- [x] Integration
- [ ] Test coverage milestones
- [x] 20%
- [ ] 40%
- [ ] 60%
## Dependencies:
- #### Common packages:
- [pedantic](https://pub.dev/packages/pedantic)
- [equatable](https://pub.dev/packages/equatable)
- [flutter_bloc](https://pub.dev/packages/flutter_bloc)
- [bloc_test](https://pub.dev/packages/bloc_test)
- [mockito](https://pub.dev/packages/mockito)
- [http](https://pub.dev/packages/http)
- [rx_dart](https://pub.dev/packages/rxdart)
- [freezed](https://pub.dev/packages/freezed)
- [build_runner](https://pub.dev/packages/build_runner)
- [json_serializable](https://pub.dev/packages/json_serializable)
- [shared_preferences](https://pub.dev/packages/shared_preferences)
- [url_launcher](https://pub.dev/packages/url_launcher)
- [geolocator](https://pub.dev/packages/geolocator)
- #### UI packages:
- [clean_settings](https://pub.dev/packages/clean_settings)
- [flutter_typeahead](https://pub.dev/packages/flutter_typeahead)
- [shimmer](https://pub.dev/packages/shimmer)
## UI inspirations
- [Material Design - Crane Travel App](https://material.io/design/material-studies/crane.html)
- [Search Flights - Mobile Booking App UI Design by Nitish Khagwal](https://dribbble.com/shots/10749939-Search-Flights-Mobile-Booking-App-UI-Design)
- [Flight Tickets Deal Tracker App | Day 340/365 - Project365 by Kishore](https://dribbble.com/shots/5662956-Flight-Tickets-Deal-Tracker-App-Day-340-365-Project365)
## Related recommended resources
- [Amadeus Travel API](https://developers.amadeus.com/self-service)
- [flutter_bloc package docs](https://bloclibrary.dev/#/)
- [Flutterly YouTube Channel - about BLoC](https://www.youtube.com/channel/UC5PYcSe3to4mtm3SPCUmjvw)
- [Freezed ❄ – Data Class & Union in One Dart Package - by Reso Coder](https://resocoder.com/2020/02/11/freezed-data-class-union-in-one-dart-package/#t-1600693077177)
- [Flutter Internationalization User Guide](http://flutter.dev/go/i18n-user-guide)
## Credits
- [Unsplash](https://unsplash.com/) (Asset Images)
## Contribution
The app is still in the development process and isn't suitable for contributions yet.
~~If you wish to contribute, file an issue with an appropriate tag or propose a PR. If it is a breaking change, please create an issue first.~~