Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielbmoro authored Feb 3, 2024
1 parent 47e92a3 commit 13e7883
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
# pocket_note
# Welcome! πŸ‘‹

Welcome to the pocket note project. This is a personal app I am using to help my self montly. It is a kind of a expenses app, but this app was made specially for me.

I live in a ranch with other families, we split the value of our Power bills, sometimes this is hard to manage because we have some values to consider comparing the previous month. The idea of the app is to help specially in this scenario.

In the future I intend to extend the features to help my self in other tasks such as: manage the food of my guinea pigs, pay monthly bills.

## Getting Started
---

## How to run the project? πŸ“¦

After you clone the app, download all dependencies, you need to generate code using the folling command:

```dart run build_runner build --delete-conflicting-outputs```

We need to generated code because we are using the libraries that requires this, this libraries are: Injectable, Mobx, and Autoroute.

---

### Tech stack summary πŸ› οΈ

- [Auto Route](https://pub.dev/packages/auto_route) - Navigation 🧭
- [MobX](https://pub.dev/packages/mobx) - State management ♻️
- [Get it](https://pub.dev/packages/get_it) - Dependency Injection πŸ’‰
- [Injectable](https://pub.dev/packages/injectable) - Dependency Injection πŸ’‰
- [Share Plus](https://pub.dev/packages/share_plus) - Share text βž•
- [Sqflite](https://pub.dev/packages/sqflite) - Data storage 🧊

0 comments on commit 13e7883

Please sign in to comment.