fnmora / offlinetodolist

:watermelon: Offline To-Do list app with WatermelonDB :watermelon:

Offline To-Do List

Register a new To-Do and organize your tasks
🍉 Offline To-Do list app with WatermelonDB 🍉

WatermelonDB · Report Bug · Request Feature

Contents

• About the Project
  • Built With
• Getting Started
  • Installation
• Roadmap
• Contributing
• Screenshots
• Contact

About The Project

This is a simple project to study the watermelonDB tool. Where a database was created with a To-Dos table, so the user can create, delete and check/uncheck the task is done. The use of watermelon allows the application to be completely offline, where the user will always have the data saved in the device.

Note: This is a very simple project and I don't recommend using watermelon, this is just an example.

Built With

• React-Native
• WatermelonDB
• React Native Vector Icons
• React Navigation

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

git clone https://github.com/fhugoduarte/OfflineToDoList.git

2. Install packages

yarn install

3. Run android project

yarn android

3. Run ios project

cd ios && pod install

yarn ios

Roadmap

• Configure watermelonDB
• List saved To-Dos
• Create new To-Do
• Delete existing To-Do
• Check/Uncheck a To-Do
• Filter To-Dos by done status
• Synchronize with a fake api

Contributing

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

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Screenshots

Contact

Hugo Duarte - LinkedIn - GitHub