Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ayushbherwani1998/unsplash_sample

This repository showcases the implementation of Flutter concepts such as Pagination, Bloc pattern, Dependency Injection (DI), Code Coverage, Testing, Clean Architecture, Analytics using Mixpanel and Feature flagging using Unleash
https://github.com/ayushbherwani1998/unsplash_sample

analytics bloc codecov dart dependency-injection feature-flags flutter unleash workflows

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/ayushbherwani1998/unsplash_sample
Owner: AyushBherwani1998
License: mit
Created: 2023-07-27T09:20:35.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-01-22T03:32:25.000Z (10 months ago)
Last Synced: 2024-11-02T11:11:41.848Z (18 days ago)
Topics: analytics, bloc, codecov, dart, dependency-injection, feature-flags, flutter, unleash, workflows
Language: Dart
Homepage:
Size: 854 KB
Stars: 10
Watchers: 1
Forks: 2
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

![unsplash_sample](https://github.com/AyushBherwani1998/unsplash_sample/actions/workflows/main.yml/badge.svg?branch=main)
[![codecov](https://codecov.io/gh/AyushBherwani1998/unsplash_sample/branch/main/graph/badge.svg?token=N2TBGQQPCU)](https://codecov.io/gh/AyushBherwani1998/unsplash_sample)
![license](https://img.shields.io/badge/license-MIT-blue.svg)
# Unsplash Sample Flutter Project

Welcome to the Unsplash Sample Flutter Project! This repository showcases the implementation of Flutter concepts such as Bloc pattern, Dependency Injection (DI), Code Coverage, Testing, Clean Architecture, Analytics using [Mixpanel](https://mixpanel.com/home/), Feature flagging & A/B testing using [Unleash](https://www.getunleash.io). Whether you're a Flutter enthusiast or a developer aiming to learn these practices, this project offers valuable insights.

## Table of Contents

- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Start Unleash](#start-unleash)
- [Enviroment](#enviroment)
- [Project Structure](#project-structure)
- [Dependency Injection](#dependency-injection)
- [Testing](#testing)
- [CodeCoverage](#code-coverage)
- [License](#license)
- [Analytics](#analytics)
- [A/B Testing](#ab-testing)

## Features

- Implementation of the Bloc pattern for efficient state management.
- Utilization of GetIt for managing and injecting dependencies.
- Codecov setup to ensure thorough testing and quality assurance.
- Well-organized project structure following Clean Architecture principles.
- Utilization of Unleash to demonstrate feature flagging.
- Utilization of Unleash and Mixpanel to demonstrate A/B testing.
- Integration of MixPanel to track user behavior and analyze app usage patterns for better insights.

## Getting Started

Follow these steps to set up and run the project on your local machine.

### Prerequisites

- Ensure that you have [Flutter](https://flutter.dev/docs/get-started/install) installed on your machine.
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
- Ensure that you have [Unplash API key](https://unsplash.com/documentation#creating-a-developer-account)
- Ensure that you have [Mixpanel API key](https://docs.mixpanel.com/docs/tracking/how-tos/api-credentials)
### Installation

1. Clone the repository:
```bash
git clone https://github.com/AyushBherwani1998/unsplash_sample.git
```

2. Navigate to the project directory:
```bash
cd unsplash_sample
```

3. Install dependencies:
```bash
flutter pub get
```
### Start Unleash

1. Clone the Unleash repo:
```bash
git clone [email protected]:Unleash/unleash.git
cd unleash
```
2. Create and attach container:
```bash
docker compose up -d
```

The Unleash instance will be up and running on localhost:4242. The default username and password will be `admin` & `unleash4all` respectively.

### Enviroment

You need to setup envoirment while working on this sample. Create a `.env` file under `lib/core/` with the following content:
```
UNSPLASH_API_KEY = hgs9ZVWrHQncX8d9tLmy-zq21412
UNLEASH_API_KEY = *:development.xxxxyyyyzzz
MIXPANEL_API_KEY = f9cbf11xxxxxxxxxxxxc695db39a
```

## Project Structure

The project adheres to Clean Architecture principles, promoting separation of concerns and maintainability. Notable directories include:

- `lib/features/**`: Contains the primary application code.
- `lib/features/**/data/`: Manages data handling, repositories, and data sources.
- `lib/features/**/domain/`: Encompasses business logic, use cases, and entities.
- `lib/features/**/presentation/`: Handles UI components, Blocs, and Widgets.

## Dependency Injection

Dependency Injection (DI) is facilitated using the [get_it](https://pub.dev/packages/get_it) package. This fosters organized code and enhanced testability by efficiently managing dependencies.

## Testing

Unit and widget tests are included to ensure code reliability. Execute tests with the following command:

```
flutter test
```

## Code Coverage

Code coverage is enforced using test coverage tools like [codecov](https://about.codecov.io/). This helps track tested code areas and identifies segments needing more thorough testing. You can checkout the Grid graph for the repo below:

## Analytics

For app analytics we are using Mixpanel. It's used to track the user behavoiour and usage pattern in the application. You can checkout a gist of app analytics in the screenshot given below:

## A/B testing
For the app we are using Unleash to perform A/B testing and mixpanel to collect analytics and funnel.

### Configuration:
- Create `likeOptionExperiment` flag in Unleash instance with toggle called `experiment`
- Create two varinats `gridTile` and `imageDetails` for testing
- Enable the flags :tada:

Below is a funnel screenshot for “like image” experimentation

## License
```
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```