Striiikly App 🌤️

Transform your GitHub activity into a competitive arena. Earn points, climb the leaderboard, and challenge your friends to prove who's the ultimate coder. Track your contributions, build streaks, and unlock achievements while showcasing your skills to the world.

---

Features ✨

• Gamified Contribution Tracking: Earn points for commits, pull requests, issues, and more.
• Daily Streaks: Track and maintain your contribution streaks to stay consistent.
• Leaderboards: Compete with friends or other developers and climb to the top.
• Dynamic Levels: Level up every 500 points and showcase your progress.
• Profile Overview: View your total points, streaks, and rank in one place.
• Achievements: Unlock badges and milestones for key GitHub activities.
• Reminders: Get daily nudges to ensure you don’t miss contributing.
• Interactive Challenges: Challenge friends to coding duels for extra points.
• Activity Insights: Visualize your GitHub activity with clear graphs and stats.

---

Clean Architecture and State Management

This app is built following Clean Architecture principles, ensuring separation of concerns and scalability. It uses BLoC (Business Logic Component) for state management, enabling reactive programming and improving maintainability.

---

Installation and Setup 🛠️

Quick Testing

Download Sample apk Here Video Walkthrough Here

Prerequisites

Ensure the following are installed on your system:

• Flutter SDK (v3.7.0 or later)
• Dart SDK (v2.19.0 or later)
• Android Studio or Xcode (for iOS development)
• OpenWeather API Key (Sign up here)

Steps

1. Clone the Repository:

   git clone https://github.com/KenyaFlutterDev/Striiikly.git
   cd Striiikly  

2. Install Dependencies::

3. Set Up API Key::

      Add your corresponding  Release/Debug GitHub API key in the following format:  
      BASE_URL=http://api.github.com./
      API_KEY=YOUR KEY HERE 
   

4. Run the App::

      flutter run
      For iOS:
      flutter run -d ios
   

5. Run the App::
   Folder Structure 🗂️ The project follows Clean Architecture principles and organizes code into layers:

      lib/  
      ├── core/            # Shared resources (e.g., error handling, utilities)  
      │   ├── network/     # Network and API handling  
      │   └── theme/       # Application-wide themes and styles  
      ├── features/        # Feature-specific code  
      │   ├── weather/     # Weather-related functionality  
      │   │   ├── data/    # Data sources, models, and repositories  
      │   │   ├── domain/  # Business logic (use cases and entities)  
      │   │   └── presentation/  
      │   │       ├── bloc/      # Bloc files for state management  
      │   │       └── screens/   # UI screens (Striiikly, LeaderBoardScreen)  
      ├── main.dart        # Entry point of the app  
   

Approach ✨

1. Clean Architecture:

    Organized code into layers (Data, Domain, Presentation) to ensure separation of concerns and scalability.
    Used repositories in the Data layer to fetch weather data from the OpenWeather API.
    Implemented use cases in the Domain layer for business logic.

2. BLoC State Management:

    Leveraged flutter_bloc for state management, ensuring clean and reactive interactions between UI and business logic.
    Used events and states to handle data fetching, loading, and error scenarios effectively.

3. UI/UX Design:

    The UI is inspired by the modern mockup provided, ensuring a clean, gradient-based design and user-friendly interaction.

4. Offline Support:

    Cached responses using the shared_preferences package to allow users to access the last fetched data offline.

5. Performance Optimization:

  Implemented efficient image caching using cached_network_image.
  Optimized state changes to minimize unnecessary widget rebuilds.

Challenges Faced 🛠️

1. API Integration:

   • Handling API rate limits and ensuring smooth data fetching without delays.
   • Solution: Implemented efficient caching and limited frequent calls to the API.

2. Clean Architecture Setup:

   • Structuring the app to adhere to Clean Architecture while maintaining code readability and simplicity.
   • Solution: Carefully designed the folder structure and ensured proper separation of concerns.

3. State Management:

   • Implementing BLoC to manage UI states for data fetching, loading, and error handling without affecting app performance.
   • Solution: Leveraged best practices with streams and events to handle complex states.

4. Offline Functionality:

   • Ensuring a seamless experience when there is no internet connection.
   • Solution: Used shared_preferences and hive to store data locally and inform users about offline mode.

5. UI/UX Challenges:

   • Mimicking the modern UI theme with reusable widgets while maintaining performance.
   • Solution: Carefully designed components with responsiveness and animation effects for better user experience.

How It Works ⚙️

1. Authenticate via Github:

   • The app Authenticates with Github to be able to give a user a session and get their git activity.

2. Display Data:

   • The Leaderboard shows current Daily, Weekly, and Monthly activity. The achievments page shows user achievements and level, the Notifications shows any notifications a user has..

3. Offline Access:

   • When offline, cached data is displayed with a message indicating it may not be up to date.

---

Screenshots 📸

Leaderboard	Teams	Notifications Today	Achievments

---

Future Improvements 🛠️

1. Add support for multi-language weather descriptions.
2. Implement user-defined themes (light and dark modes).
3. Enhance offline storage to cache Git Activity.

---

License 📝

This project is licensed under the MIT License.

---

Contributions 🤝

Contributions are welcome! Feel free to fork the repository and submit a pull request.