Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Besufikad17 committed Aug 15, 2023
1 parent a415016 commit cad59df
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 9 deletions.
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
# todolist

A new Flutter project.
Simple todolist app made by using bloc pattern..

## Getting Started

This project is a starting point for a Flutter application.
A Bloc is a more advanced class which relies on `events` to trigger `state` changes rather than functions. Bloc also extends `BlocBase` which means it has a similar public API as `Cubit`. However, rather than calling a function on a `Bloc` and directly emitting a new `state`, `Blocs` receive `events` and convert the incoming `events` into outgoing `states`.

A few resources to get you started if this is your first Flutter project:
<img src="media/bloc_architecture_full.png">

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
[source: pub.dev/packages/bloc](https://pub.dev/packages/bloc)

In this project I implemeted BloC pattern for the todo list and theme picker like this:

<img src="media/bloc-diagram.png">

## Libraries used

| library | version |
| ------- | ------- |
| [flutter_bloc](https://pub.dev/packages/flutter_bloc) | 8.1.3 |
| [equatable](https://pub.dev/packages/equatable) | 2.0.5 |
| [hive](https://pub.dev/packages/hive) | 2.2.3 |
| [hive_flutter](https://pub.dev/packages/hive_flutter) | 1.1.0 |
| [build_runner](https://pub.dev/packages/build_runner) | 2.4.6 |

## Usage

You can download and install the app from the [release](https://github.com/Besufikad17/todolist/releases/) section. If you want to clone the project and play with it check the following steps.

```bash
git clone https://github.com/Besufikad17/todolist.git &&
cd todolist &&
flutter pub get &&
flutter run
```

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
1 change: 0 additions & 1 deletion lib/models/theme.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import 'package:equatable/equatable.dart';
import 'package:hive/hive.dart';
import 'package:todolist/global/theme/themes.dart';

part 'theme.g.dart';

Expand Down
Binary file added media/bloc-diagram.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/bloc_architecture_full.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cad59df

Please sign in to comment.