Skip to content

πŸ“ Node.js CLI TODO app with JSON storage, real-time UI, and add/delete/mark-done support. Simple and efficient.

Notifications You must be signed in to change notification settings

BhaveshG-22/CLI-Todo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


πŸ“ TaskMaster CLI

A simple and efficient filesystem-based TODO manager built using Node.js.

πŸš€ Developed as part of Harkirat’s cohort Assignment #2 with no AI assistanceβ€”just official docs and hands-on coding!


✨ Features

βœ… Add a TODO
βœ… Delete a TODO
βœ… Mark a TODO as done
βœ… Persistent storage using JSON
βœ… Beautiful CLI UI with Chalk & Commander
βœ… Fully functional help menu


πŸ“¦ Installation

Ensure you have Node.js installed. Then, clone this repository and install dependencies:

git clone https://github.com/yourusername/taskmaster-cli.git  
cd taskmaster-cli  
npm install  

πŸš€ Usage

πŸ“Œ Add a Task

node index.js add "Finish assignment"

βœ… Mark a Task as Done

node index.js done <taskID>

Example:

node index.js done 1

❌ Delete a Task

node index.js delete <taskID>

Example:

node index.js delete 1

πŸ“œ Display All Tasks

node index.js display

ℹ️ Help Menu

node index.js --help

πŸ–Ό Screenshots

Include the following screenshots for better documentation:

  1. Help Menu (node index.js --help) - Showcases available commands.

Screenshot 2025-02-18 at 6 40 58β€―AM

  1. Adding a Task (node index.js add "task-name") - Demonstrates how tasks are added.

Screenshot 2025-02-18 at 6 43 01β€―AM

  1. Displaying Tasks (node index.js display) - Shows the task list in the formatted CLI UI.

Screenshot 2025-02-18 at 6 41 31β€―AM

  1. Marking a Task as Done (node index.js done <taskID>) - Displays a task being marked as done.

Screenshot 2025-02-18 at 6 44 57β€―AM

  1. Deleting a Task (node index.js delete <taskID>) - Shows a task being deleted.

Screenshot 2025-02-18 at 6 45 46β€―AM


πŸ›  Tech Stack

  • Node.js
  • Chalk (for styling terminal output)
  • Commander (for command-line interface)
  • File System (fs) (for JSON-based storage)

πŸ“‚ Project Structure

πŸ“¦ taskmaster-cli  
 ┣ πŸ“‚ helpers/  
 ┃ ┣ πŸ“œ display.js  
 ┃ ┣ πŸ“œ taskManager.js  
 ┃ ┣ πŸ“œ getSize.js  
 ┣ πŸ“œ index.js  
 ┣ πŸ“œ package.json  
 ┣ πŸ“œ todos.json (Stores tasks)  
 β”— πŸ“œ README.md  

🀝 Contributions

Feel free to fork and improve the tool! Open a PR if you have suggestions. πŸš€


πŸ“œ License

This project is open-source under the MIT License.


About

πŸ“ Node.js CLI TODO app with JSON storage, real-time UI, and add/delete/mark-done support. Simple and efficient.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published