enrique-lozano / Monekin

A 100% Open Source app that tries to make personal finances easier. Fast, simple, without ads, without the need for an Internet connection and with a groundbreaking design, that's Monekin.
GNU Affero General Public License v3.0
67 stars 17 forks source link
finance-management flutter-app hybrid-app material-design money-manager open-source personal-finances


App Icon

Monekin - Official repository

Monekin is a 100% Open Source app that tries to make personal finances easier. Fast, simple, without ads, without the need for an Internet connection and with a groundbreaking design, that's Monekin.
Start exploring »

Google Play Badge

Table of Contents
  1. About The Project
  2. Run the code locally
  3. Contributing
  4. Contact

About the project

1 2 3 4
5 6

Why Monekin?

After a lot of research on the marketplaces I could not find any application that met all my needs. That is why I decided to start making my own app. After months of hard work, the first version was released on Google Play in October 2021. I decided to make it 100% Open Source shortly after, with the aim of increasing its user community, and that external developers could help and collaborate with me on the project. Since the day of its release, the app has been continuously improving and updating.

Tech Stack

At the beggining the app was developed in Ionic and Angular. In 2023, in order to make our app better, we migrate the app to Flutter, which allow us to have a modern and scalable application for a large number of operating systems and platforms.

To store and persist your data in the app we store a SQLite database directly in your device, thanks to an opensource package called drift

Run the code locally 🚀🧑‍💻

The following explains how to run the project code locally. This way you will be able to investigate on your own how it is done, create new features, fix bugs, etc.

Prerequisites

As with any Flutter project, you need to install the framework in your machine. Visit the official docs for more info. You should also have git installed in your machine.

Installation

Open a terminal on your computer and go to the folder where you want to place the project. Then clone the project and install the dependencies by typing the following commands:

git clone https://github.com/enrique-lozano/Monekin.git
cd Monekin
flutter pub get

If everything went correctly these commands will finish executing without errors. Now you can run flutter run on your terminal to open the app locally in your device. The app will be refreshed when changes in the code appear. Before making any changes into the code is recommended to read the code contribution guide

Contributing 🙋🏻

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make here are greatly appreciated.

Read through our contributing guidelines to learn about how you can collaborate making Monekin better. All Pull Requests are welcome and will be studied without exception!

Why to contribute?