AniTrack - Anime & TV Series Tracker

AniTrack is a comprehensive mobile application designed to be the ultimate companion for passionate anime and TV series fans. Built with modern Android development practices, it provides seamless progress tracking, discovery features, and community engagement capabilities.

🎯 Project Overview

AniTrack enables users to:

• Track Progress: Manage shows under categories like "Watching", "Completed", "Plan to Watch", etc.
• Discover Content: Browse trending shows, editor's picks, and popular content
• Community Features: Join discussion clubs and share reviews with a unique four-option rating system
• Offline Support: View and manage watchlists without internet connection
• Deep Link Integration: Seamlessly navigate to streaming platforms

🚀 Features

Phase 1 (MVP - Current)

• ✅ User authentication system
• ✅ Third-party API integration (TMDB)
• ✅ Core watchlist functionality
• ✅ Offline data access
• ✅ Modern Material 3 UI with Jetpack Compose
• ✅ Responsive design with dark/light theme support

Phase 2 (Community Features - Planned)

• 🔄 Four-option review system (Skip, Timepass, Go for it, Perfection)
• 🔄 Forum-style discussion clubs
• 🔄 Spoiler protection mechanisms
• 🔄 Admin panel for moderation

Phase 3 (Enhancements - Planned)

• 🔄 AI-powered recommendation engine
• 🔄 Curated discovery dashboard
• 🔄 User analytics dashboard
• 🔄 Advanced search and filtering

🛠 Technical Stack

• Frontend: Jetpack Compose, Material 3
• Architecture: MVVM with Clean Architecture
• Dependency Injection: Hilt
• Database: Room with SQLite
• Networking: Retrofit + OkHttp
• Image Loading: Coil
• Navigation: Navigation Compose
• State Management: StateFlow
• Build System: Gradle with Kotlin DSL

📱 Screenshots

Screenshots will be added as the app development progresses

🚀 Getting Started

Prerequisites

• Android Studio Hedgehog or later
• Android SDK 24+ (API level 24)
• Kotlin 2.0.21+
• JDK 11+

Installation

1. Clone the repository

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

2. Get TMDB API Key

   • Visit The Movie Database
   • Create an account and request an API key
   • Replace YOUR_TMDB_API_KEY_HERE in app/src/main/java/com/rajveer/anitrack/data/remote/Constants.kt

3. Build and Run

   • Open the project in Android Studio
   • Sync Gradle files
   • Build and run on your device or emulator

Configuration

The app uses several configuration files:

• gradle/libs.versions.toml - Dependency versions
• app/build.gradle.kts - App-specific build configuration
• app/src/main/java/com/rajveer/anitrack/data/remote/Constants.kt - API configuration

🏗 Project Structure

app/src/main/java/com/rajveer/anitrack/
├── data/
│   ├── local/           # Room database and DAOs
│   ├── remote/          # API service and responses
│   ├── repository/      # Data coordination layer
│   └── mapper/          # Data transformation
├── di/                  # Dependency injection modules
├── ui/
│   ├── components/      # Reusable UI components
│   ├── navigation/      # Navigation setup
│   ├── screens/         # Individual screen implementations
│   └── theme/           # App theming
└── MainActivity.kt      # Main entry point

🔧 Development

Adding New Features

1. Data Layer: Create models, DAOs, and repository methods
2. UI Layer: Implement screens and components
3. Navigation: Update navigation graph and routes
4. Testing: Add unit tests and UI tests

Code Style

• Follow Kotlin coding conventions
• Use meaningful variable and function names
• Add comprehensive documentation for public APIs
• Implement proper error handling
• Follow Material Design guidelines

📊 API Integration

The app currently integrates with:

• TMDB (The Movie Database): Primary data source for shows, movies, and metadata
• Future: Potential integration with AniList, TVDB, or other anime-specific APIs

API Endpoints Used

• Search shows: /search/multi
• Trending content: /trending/all/week
• Popular TV shows: /tv/popular
• Popular movies: /movie/popular
• Show details: /tv/{id}
• Movie details: /movie/{id}

🔒 Security & Privacy

• User data is stored locally with encryption
• API keys are stored securely (not in version control)
• No personal data is shared with third parties
• Offline-first approach ensures data privacy

🧪 Testing

Running Tests

# Unit tests
./gradlew test

# Instrumented tests
./gradlew connectedAndroidTest

Test Coverage

• Unit tests for ViewModels and Repositories
• Integration tests for database operations
• UI tests for critical user flows

📦 Building

Debug Build

./gradlew assembleDebug

Release Build

./gradlew assembleRelease

APK Location

Generated APKs can be found in app/build/outputs/apk/

🚀 Deployment

Google Play Store

1. Generate signed APK/AAB
2. Update version code and name
3. Upload to Play Console
4. Submit for review

Internal Testing

• Use Firebase App Distribution
• Share APK directly with testers
• Use Google Play internal testing track

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Development Workflow

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• TMDB for providing the API
• Material Design for design guidelines
• Jetpack Compose team
• Android developer community

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: support@anitrack.app

🔮 Roadmap

Q1 2024

• Project setup and architecture
• Basic UI framework
• API integration foundation
• User authentication
• Core watchlist functionality

Q2 2024

• Community features
• Review system
• Forum implementation
• Admin panel

Q3 2024

• AI recommendations
• Advanced analytics
• Performance optimization
• Beta testing

Q4 2024

• Public release
• User feedback integration
• Feature refinement
• Community expansion

---

Made with ❤️ for the anime and TV series community