TutorLog 📚

A modern Android application for tutors to manage students, track progress, and organize tutoring sessions built with Jetpack Compose and Clean Architecture.

📱 Features

• Google Sign-In Authentication - Secure login using Google OAuth
• Student Management - Add, view, and organize students
• Group Management - Organize students into groups
• Home Dashboard - Overview of tutoring activities
• Modern UI - Built with Jetpack Compose and Material Design 3
• Edge-to-Edge Display - Immersive full-screen experience

Tech Stack

• UI Framework: Jetpack Compose
• Navigation: Compose Destinations
• Dependency Injection: Dagger Hilt
• State Management: Orbit MVI
• Networking: Retrofit + OkHttp
• Authentication: Firebase Auth + Google Sign-In
• Image Loading: Coil
• Async: Kotlin Coroutines + Flow
• Build System: Gradle (Kotlin DSL)

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/yourusername/tutorLog.git
cd tutorLog

2. Setup Firebase

1. Go to Firebase Console
2. Create a new project or use an existing one
3. Add an Android app with package name: com.example.tutorlog
4. Download google-services.json and place it in the app/ directory
5. Enable Google Sign-In in Firebase Authentication

3. Build and Run

./gradlew clean build
./gradlew installDebug

Or simply open the project in Android Studio and click Run.

🎨 Key Components

Authentication Flow

1. Login Screen: Google Sign-In integration
2. User Creation: Store user data locally and in Firebase
3. Session Management: Persist user session with SharedPreferences

Home Dashboard

• User profile display
• Quick access to students
• Navigation to different sections
• Bottom navigation bar

Student Management

• View all students
• Organize students into groups
• Add new students
• Toggle between individual and group views

🔧 Configuration

Minimum SDK Requirements

• minSdk: 24 (Android 7.0)
• targetSdk: 35 (Android 15)
• compileSdk: 35

🎨 Design System

The app uses a custom design system with:

• Color Palette: Dark theme optimized
• Typography: Custom text styles
• Components: Reusable composable components
• LocalColors: Compose local provider for consistent theming

🚧 Known Issues & Limitations

• Backend API integration is in progress
• Some features are under development
• Limited offline support

👨‍💻 Author

Samarth Raj

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📞 Support

For support, email [email protected] or open an issue in the repository.

🙏 Acknowledgments

• Jetpack Compose
• Compose Destinations
• Orbit MVI
• Firebase
• Dagger Hilt

---

Made with ❤️ using Jetpack Compose