Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ Branches

- [01-create-project](./doc/01-create-project.md)
- [02-re-intro](./doc/02-re-intro.md)
- [03-client-app](./doc/03-client-app.md)

16 changes: 16 additions & 0 deletions doc/03-client-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Description
A lightweight CLI(Command-Line Interface) that helps to manage a todo list application.

## Run
Navigate to the /src/ui path and run the following command:
```node --experimental-modules cli.mjs```

## Usage

* ```todo add <todoText>``` - Create a new todo. Example: ```todo add 'Read Game of Thornes book.'```
* ```todo clear <'active'|'all'|'completed'>``` - Deletes all todos or a subset of them. Example: ```todo delete 'all'```
* ```todo delete [ids...]``` - Deletes a todo(s). Example: ```todo delete 'id1' 'id2'```
* ```todo done [ids...]``` - Marks a todo(s) as done. Example: ```todo done 'id1' 'id2'```
* ```todo show <'active'|'all'|'completed'>``` - Lists all todo or a subset of them. Example: ```todo show 'active'```
* ```todo update <todoId> <todoText>``` - Allows to update the text of a specific todo. Example: ```todo update 'id1', 'Read Lord of the Rings book.'```
* ```help``` - Displays all availables commands
300 changes: 300 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {},
"dependencies": {
"vorpal": "^1.12.0"
},
"devDependencies": {
"babel-plugin-transform-object-rest-spread": "^6.26.0",
"babel-preset-env": "^1.7.0",
Expand Down
Loading