lailton-b / notes-app

A simply notes app

This is a project from The complete Node.js Developer Course - section 04.

How does it works?

1st - You need to install nodejs and npm or yarn

2nd - You need to clone this repository.

3rd - Open the project and run yarn or npm install to install all dependencies.

4th - You can now type yarn command --help or npm run command --help on your terminal to see all the commands available. Of course, you can always see the commands down bellow as well.

Everytime you wish to run a command you shall type yarn command nameOfTheCommand --nameOfTheArgument="value" or npm run command nameOfTheCommand --nameOfTheArgument="value"

List of commands

---

add

Description: adds a new note
Params:
--title | string | required
--body | string | required

---

remove

Description: remove a note
Params:
--title | string | required

---

list

Description: list all notes
Params:
none

---

read

Description: Read a note
Params:
--title | string | required

---

Usage example:

> yarn command add --title="My first note" --body="A note made for the purpose of demonstration"

Output:

---------------

New note added!

---------------

Title:  My first note
Body:  A note made for the purpose of demonstration