Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.61 KB

README.md

File metadata and controls

76 lines (50 loc) · 3.61 KB
Raw

Node Todo App

JavaScript NodeJS

screenshot image of app in action

Description

A Node.js command-line application for keeping track of your Todos in a simple and user-friendly way.

This project allowed me to improve my understanding of Node.js and gain experience using the Inquirer package for handling user input. It also allowed me to sharpen my JavaScript skills, particularly in utilising array methods such as map(), filter(), and forEach() effectively (to help target specific Todos), and developing a better understanding of the promise chaining method for handling asynchronous operations (to help cycle back to the main menu).

Table of contents

Getting Started

  1. Download or clone the repository
  2. Navigate to the repository folder in your terminal
  3. Run npm i to install dependencies
  4. Run node index.js to start the app

Features

The app has the ability to add, edit or delete individual Todos, as well as the ability to show or clear all Todos. The user experience is also pretty neat in that actions always cycle back to a main menu from where the user can choose to exit the app.

Limitations

There isn't any validation done on user input, which could lead to errors and unexpected behaviour. The display could benefit from improved formatting and styling.

Future Enhancements

Here are some potential enhancements that could be implemented in future:

  • Implementing input validation to ensure accurate data entry.
  • Improving the user interface with better formatting and design elements to improve the overal user experience.
  • Adding ability to assign a specific date and time to each Todo, for better organisation and planning.
  • Implementing a feature to store completed Todos for record-keeping and future reference, as opposed to deleting them completely.

Contribution

I welcome any and all contributions to the project. If you're interested in helping out, here are a few ways you can get involved:

  1. Fork the repository and create a pull request with your changes.
  2. Submit an issue to report bugs or request new features.
  3. Help improve the documentation.

Please follow the guidelines for contributions:

  • Make sure your code is well-documented and follows the same style as the rest of the codebase.
  • Keep pull requests small and focused on a single change.

If you have any questions or suggestions, feel free to contact me via email.

Credits

Back to top