Locstream is a real-time location sharing and monitoring app designed to help users keep track of friends, family, or team members. It provides secure authentication, profile management, and features for adding watchers and watching others, all built with Flutter for cross-platform support.
- User Authentication: Secure signup, login, and account verification using OTP.
- Profile Management: Edit and update user profiles, including profile pictures.
- Location Sharing: Share your location with selected watchers and view their locations in real time.
- Watchers & Watching: Add new watchers, manage who you are watching, and see lists of both.
- Settings: Customize app preferences and privacy settings.
- Offline Support: Access profile and watcher data even when offline.
- Cross-Platform: Runs on Android, iOS, Web, Windows, macOS, and Linux.
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
- Flutter SDK: 3.x.x or latest (Install Flutter)
- Dart SDK: 3.x.x or latest (included with Flutter)
- Android Studio or VS Code (recommended IDEs)
- Xcode (for iOS development)
- API Keys: If using map or location services, add your Google Maps API Key to the appropriate configuration files.
- Clone the repository:
git clone https://github.com/your-username/locstream-app.git cd locstream-app - Install dependencies:
flutter pub get
- Run the app:
flutter run
For multiple flavors or configurations, use:
flutter run --flavor <flavor-name>
-
Sign Up / Log In:
Launch the app and create a new account or log in using your email and OTP verification. -
Edit Profile:
Navigate to the profile section to update your details and profile picture. -
Add Watchers:
Use the "Add New Watcher" screen to invite others to watch your location. -
View Watchers & Watching:
Access the drawer to see who you are watching and who is watching you. -
Share Location:
Enable location sharing to allow your watchers to see your real-time location. -
Settings:
Adjust privacy and notification preferences in the settings screen.
A brief overview of how the project is structured:
locstream-app/
|- android/ # Android specific files
|- ios/ # iOS specific files
|- lib/ # Main Flutter application code
| |- main.dart # Main application entry point
| |- core/ # Core services, utilities, constants
| |- data/ # Data layer (models, repositories, data sources)
| |- views/ # UI layer (screens, widgets)
| |- view_models.dart # Riverpod providers and state management
|- test/ # Unit and widget tests
|- pubspec.yaml # Project dependencies and metadata
|- README.md # This file
...
Contributions are welcome! If you'd like to contribute, please follow these steps:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please make sure to update tests as appropriate.
This project is Unlicensed.
Anyone is free to clone, use, modify, and distribute this repository and its contents for any purpose, without restriction.
Bilal Mbaka - mbakabilal@yahoo.com
Privilege icons created by sahila99 - Flaticon No-connection animated icons created by Freepik - Flaticon Machine-learning animated icons created by Freepik - Flaticon Correct animated icons created by Freepik - Flaticon Suggestion icons created by Nurlaili - Flaticon Visibility icons created by smashingstocks - Flaticon Moody icons created by Mohammad Anggi Hardiansyah - Flaticon