Table of Contents
This is a simple mobile app fully made with Flutter. To run the project locally:
- Make sure to have the latest version of Flutter installed on your machine.
- Download the project files either by cloning or downloading the project as ZIP.
- Install the dependencies with
flutter pub get. - Make sure to have a physical Android device with USB drivers installed or an Android emulator to run this app on. Important note: This app has only been tested on Android 12.
- Clone the repo
git clone https://github.com/itsmosalah/nota.git
- Install dependencies using flutter pub
flutter pub get
- flutter_bloc | for state management.
- flutter_quill | for rich text editing.
- sqflite | for local database.
- path | for finding local database path.
- flutter_colorpicker | for picking custom colors when creating labels.
- theme_provider | for providing theme data across the app.
- Create Notes and save them in local database.
- Create Labeling system with label filters.
- Add themes options with dark mode.
- Add options to customize the notes order.
- Add sorting options.
- Add an option to pin notes.
- Create unit and widget tests.
- Create a documentation for project design.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Mohamed Abdelrahman - [email protected] -
Project Link: https://github.com/itsmosalah/nota