msb-public
/
samples
mirror of https://github.com/flutter/samples.git
1
0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ad86bf554b'
${ noResults }
samples/compass_app/README.md

2.1 KiB
Raw Blame History Escape

compass_app

The Compass sample application is an app that helps users build and book itineraries for trips. It’s a robust sample application with many features, routes, and screens. The app communicates with an HTTP server, has development and production environments, brand-specific styling, and high test coverage. In these ways and more, it simulates a real-world, feature rich Flutter application.

The code in this application is used for explaining architecture in a Flutter application.

compass app splash screen compass app activities screen compass app home screen compass app booking screen

The Compass app was originally designed and built by the Firebase GenKit team.

Running the app

This app contains multiple environments.

  • Development environment - This environment uses data from a JSON file, which is stored in the assets directory, and simulates developing locally.
$ cd app
$ flutter run --target lib/main_development.dart
  • Staging environment - This environment uses an HTTP server to get data, simulating a real app experience. This is a "dummy" server, that has endpoints that simply return fake data. The server can be found in the compass_app/server directory. You need to run the server locally before running the Flutter application.
$ cd server
$ dart run
# => Server listening on port 8080
 
$ cd ../compass_app/app
$ flutter run --target lib/main_staging.dart

Integration Tests

Integration tests must be run from the app directory.

Integration tests with local data

cd app
$ flutter test integration_test/app_local_data_test.dart

Integration tests with background server and remote data

cd app
$ flutter test integration_test/app_server_data_test.dart

Running the tests together with flutter test integration_test will fail. See: https://github.com/flutter/flutter/issues/101031