https://github.com/snsakib/notes-app

A basic CLI based note taking app developed with Node.js
https://github.com/snsakib/notes-app

Last synced: about 11 hours ago
JSON representation

A basic CLI based note taking app developed with Node.js

• Host: GitHub
• URL: https://github.com/snsakib/notes-app
• Owner: snsakib
• Created: 2018-12-15T10:58:34.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-30T01:55:21.000Z (over 1 year ago)
• Last Synced: 2024-11-17T04:28:43.265Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# notes

This is a basic CLI based note taking app build with Node.js.

I build this app for a course project while I was learning about nodeJS from [Udemy](https://www.udemy.com/the-complete-nodejs-developer-course-2/)

## Installation Steps:

1. Download or clone the files form this github [repo](www.github.com)

2. Start command promt (Windows) / terminal (MAC)

3. Navigate to the installed folder

4. run `npm install`

5. You are all set!

## Documentation:

1. **Add a new note:**

    run `node app.js add --title="Note title" --body="Note body"`

    or

    run `node app.js add -t "Note title" -b "Note body"`

1. **Remove a note:**

    run `node app.js remove --title="Note title"`

    or

    run `node app.js remove -t "Note title"`

1. **Read a saved note:**

    run `node app.js read --title="Note title"`

    or

    run `node app.js read -t "Note title"`

1. **Show all notes:**

    run `node app.js list`

1. **Help:**

    run `node app.js --help`