Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/

# IntelliJ related
*.iml
*.ipr
*.iws
.idea/

# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/

# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/

# Symbolication related
app.*.symbols

# Obfuscation related
app.*.map.json

# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release

# iOS/XCode
**/ios/**/*.mode1v3
**/ios/**/*.mode2v3
**/ios/**/*.moved-aside
**/ios/**/*.pbxuser
**/ios/**/*.perspectivev3
**/ios/**/*sync/
**/ios/**/.sconsign.dblite
**/ios/**/.tags*
**/ios/**/.vagrant/
**/ios/**/DerivedData/
**/ios/**/Icon?
**/ios/**/Pods/
**/ios/**/.symlinks/
**/ios/**/profile
**/ios/**/xcuserdata
**/ios/.generated/
**/ios/Flutter/App.framework
**/ios/Flutter/Flutter.framework
**/ios/Flutter/Flutter.podspec
**/ios/Flutter/Generated.xcconfig
**/ios/Flutter/ephemeral/
**/ios/Flutter/app.flx
**/ios/Flutter/app.zip
**/ios/Flutter/flutter_assets/
**/ios/Flutter/flutter_export_environment.sh
**/ios/ServiceDefinitions.json
**/ios/Runner/GeneratedPluginRegistrant.*

# Web
/web/

# Windows
windows/

# Linux
linux/

# macOS
macos/
93 changes: 93 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Changelog

All notable changes to Smart Lab Guardian will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2024-10-20

### Added
- Initial release of Smart Lab Guardian
- Real-time sensor monitoring dashboard
- Temperature sensor (°C)
- Gas level sensor (PPM)
- Fire detector
- Distance sensor (cm)
- Alert system with automatic threshold monitoring
- Configurable sensor thresholds in Settings
- Local data persistence using SharedPreferences
- Material Design 3 UI with bottom navigation
- Color-coded status indicators (Safe/Warning/Danger)
- Alert acknowledgment system
- Simulated sensor data service
- Comprehensive documentation
- README with feature overview
- Quick Start Guide
- Hardware Integration Guide
- Firebase Setup Guide
- Contributing Guidelines
- Unit tests for models and services
- Widget tests for UI components
- Clean architecture with separation of concerns
- Models layer
- Services layer
- Providers layer (Riverpod)
- UI layer (Screens and Widgets)

### Technical Details
- Flutter SDK 3.0.0+
- State management: Riverpod 2.4.0
- Local storage: SharedPreferences 2.2.2
- Charts: FL Chart 0.65.0
- Support for future Firebase integration
- Support for future Hive database integration

### Documentation
- Inline code comments explaining integration points
- Hardware sensor integration examples
- Arduino code examples for common sensors
- Firebase cloud sync setup instructions

## [Unreleased]

### Planned Features
- [ ] Real hardware sensor integration
- [ ] Firebase cloud synchronization
- [ ] Push notifications for critical alerts
- [ ] Historical data charts
- [ ] Data export functionality
- [ ] Multi-lab support
- [ ] User authentication
- [ ] Sensor calibration interface
- [ ] Custom alert rules
- [ ] Email/SMS notifications
- [ ] Dark mode support
- [ ] Multi-language support

### Future Enhancements
- WebSocket support for real-time updates
- Offline mode with sync when online
- Advanced analytics dashboard
- Sensor health monitoring
- Maintenance scheduling
- Integration with lab management systems
- API for third-party integrations
- Mobile app for iOS and Android
- Desktop app for Windows/macOS/Linux

## Version History

### Version Numbering
- **Major version**: Breaking changes or significant new features
- **Minor version**: New features, backward compatible
- **Patch version**: Bug fixes and minor improvements

Example: 1.2.3
- 1 = Major version
- 2 = Minor version
- 3 = Patch version

---

For more information, see the [README](README.md).
Loading