https://github.com/muke78/task-tracker-cli
Backend from CLI of a task tracker
https://github.com/muke78/task-tracker-cli
cli cli-app fs javascript path todolist
Last synced: 14 days ago
JSON representation
Backend from CLI of a task tracker
- Host: GitHub
- URL: https://github.com/muke78/task-tracker-cli
- Owner: muke78
- Created: 2025-01-31T07:35:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-31T08:36:18.000Z (over 1 year ago)
- Last Synced: 2025-03-04T03:34:03.934Z (over 1 year ago)
- Topics: cli, cli-app, fs, javascript, path, todolist
- Language: JavaScript
- Homepage: https://roadmap.sh/projects/task-tracker
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
Task tracker cli is a project used to track and manage your tasks. In this task, you will build a simple command line interface (CLI) to track what you need to do, what you have done, and what you are currently working on. This project will help you practice your programming skills, including working with the filesystem, handling user inputs, and building a simple CLI application.
## Table of Contents
- [Project link](#project-link)
- [Requirements](#requirements)
- [Task Properties](#task-properties)
- [Commands](#commands)
- [Usage](#usage)
- [Screenshots](#screenshots)
- [Contact](#contact)
## Project link
[https://roadmap.sh/projects/task-tracker](https://roadmap.sh/projects/task-tracker)
## Requirements
The application should run from the command line, accept user actions and inputs as arguments, and store the tasks in a JSON file. The user should be able to:
- Add, Update, and Delete tasks
- Mark a task as in progress or done
- List all tasks
- List all tasks that are done
- List all tasks that are not done
- List all tasks that are in progress
Here are some constraints to guide the implementation:
- You can use any programming language to build this project.
- Use positional arguments in command line to accept user inputs.
- Use a JSON file to store the tasks in the current directory.
- The JSON file should be created if it does not exist.
- Use the native file system module of your programming language to interact with the JSON file.
- Do not use any external libraries or frameworks to build this project.
- Ensure to handle errors and edge cases gracefully.
## Task Properties
Each task should have the following properties:
- `id`: A unique identifier for the task
- `description`: A short description of the task
- `status`: The status of the task (`todo`, `in-progress`, `done`)
- `createdAt`: The date and time when the task was created
- `updatedAt`: The date and time when the task was last updated
## Commands
The commands are executed from the CLI with `npm run` or `yarn dev` with one of the following arguments that takes
- `add`: Add a task
- `edit`: Edit a task
- `delete`: Delete a task
- `complete`: Mark a task as completed
- `not-complete`: Mark a task as not completed
- `list`: List the tasks there are
- `list-progress`: List tasks in progress
- `list-not-done`: List tasks not completed
- `list-done`: List completed tasks
- `help`: Show command help box
## Usage
Here are the basic commands to use the CLI Task Manager Tool:
```bash
npm run add "The weekend"
npm run edit "Argument"
npm run delete
npm run complete
npm run not-complete
npm run help
```
## Screenshots
## Contact
If you have any questions or suggestions, feel free to contact us:
- Author name: [Erick Gonzalez](https://github.com/muke78)
- Email :