Nudge

The simplest to-do list application for you to be more productive
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • Installation
• Features
• Usage
• Logic
• Contribution
• License
• Challenges
• Contact

About The Project

Nudge is a Android to-do list application where you can create a simple list of anything you want to remember. Easily reorder the list, mark items as finished and delete items.

This Project is for my Term 3 elective, Native Android Development 303, for which we were tasked to create an application that can enhance productivity.

Built With

This Android application was build using:

• Kotlin
• Android Studio

Installation

1. Download and Install Android Studio https://developer.android.com/studio/
2. Clone the repo

git clone https:://github.com/ArmandPretorius/nudge.git

3. Then open the project in Android Studio

Features

Usage

When opening Nudge, you can click on the floating action button in the top-right corner to create a new nudge into the list. A dialog will pop-up in which you can add your text.

After you've created a nudge, you can click on it to mark it as finished or not.

When swiping left or right on the nudge to delete it.

If you have more than one nudge, you can long press on a nudge and drag it up and down to re-arange the list.

View Demo

Logic

The application uses SQLite to store the items on the device and populates the information into a RecycleView.

Challenges

• I wanted to include a timer function where you can select how long you think each nudge would take, then when you click on a nudge, the timer will start and then tell you when the time is up.

• I also struggled with the swipe to delete functionality, so at the moment it isn't implemented.

• Also, I wanted to implement notifications, which shows you how many nudges you have left.

• I'd also like to add a indication that there are no nudges.

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/YourAmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/YourAmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Armand Pretorius - @amplified_designs - [email protected]

Project Link: https://github.com/ArmandPretorius/nudge