Enhancing family safety and communication with real-time location sharing and modern UIs.
Welcome to YourSpace, an open-source Flutter application designed to enhance family safety through real-time location sharing and communication features. YourSpace aims to provide peace of mind by ensuring the safety of your loved ones while facilitating seamless communication regardless of their location.
YourSpace adopts a declarative UI approach with Flutter and utilizes flutter riverpod for state management. This architecture promotes a clear separation of concerns, making the codebase more maintainable, scalable, and testable. Flutter’s widget-based system allows for the creation of highly responsive UIs, while flutter riverpod ensures efficient state handling across different components, leading to a smooth and intuitive user experience.
YourSpace is currently in active development 🚧, with plans to incorporate additional features shortly.
YourSpace ensures your loved ones' well-being with:
- Real-time Location Sharing
- Secure Communication
- Location History with Routes
- Geo-fencing
- SOS Help Alert
| Create/Join Space | Share Location | Location History |
|---|---|---|
 |
 |
 |
| Geofencing | Communication |
|---|---|
 |
 |
Make sure you have the latest stable version of Android Studio installed. You can then proceed by either cloning this repository or importing the project directly into Android Studio, following the steps provided in the documentation.
Click to expand
To enable the MapView functionality, obtaining an API key as instructed in the documentation is required. This key should then be included in the local.properties for android and Info.plist for ios file as follows:
Android:
MAPS_API_KEY=your_map_api_key
IOS:
<key>ApiMapKey</key>
<string>your_map_api_key</string>
Inside the data/lib directory, create a new file named config.dart. This file will store your place API key, follow format:
class AppConfig {
static const String placeApiKey = 'YOUR PLACE API KEY';
}
To enable Firebase services, you will need to create a new project in the Firebase Console.
Use the applicationId value specified in the app/build.gradle file of the app as the Android package name.
Once the project is created, you will need to add the google-services.json file to the android/app module for android and ios/Runner module for IOS.
For more information, refer to the Firebase documentation.
YourSpace uses the following Firebase services, Make sure you enable them in your Firebase project:
- Authentication (Phone, Google, Apple)
- Firestore (To store user data)
YourSpace utilizes the latest Flutter technologies and adheres to industry best practices. Below is the current tech stack used in the development process:
- Flutter Riverpod
- Dart
- async + Stream
- Go Router
- SQLite
- Freezed
- Firebase Authentication
- Firebase Firestore
- Cloud Functions
- Google Maps Flutter
Currently, we are not accepting any contributions.
YourSpace is owned and maintained by the Canopas team. You can follow them on Twitter at @canopassoftware for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!
YourSpace is licensed under the Apache License, Version 2.0.
Copyright 2024 Canopas Software LLP
Licensed under the Apache License, Version 2.0 (the "License");
You won't be using this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.