Skip to content
Notes of Encouragement CLI app
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
.eslintrc.js
.gitignore
LICENSE
README.md
cli-app-example.png
package-lock.json
package.json

README.md

Notes of Encouragement

This is a command-line interface (CLI) application written in Node.js that displays one random note of encouragement each time it is run.

I wrote this application for my son, so he can always get a note of encouragement from me whenever he needs one. You don't even need to be connected to the Internet!

Example Note

Modifying For Someone Special in Your Life

If you want to use this application for someone special, you can update the following using a good editor like Visual Studio Code:

  • /bin/notes.json: this contains a JavaScript object with an array of introductions and an array of notes.
  • /package.json: change the /bin to be whatever command you want. Right now it's set to heybuddy. Change yours to heygirl, heyprincess, hi-beautiful, or whatever you wish!

Installing on Someone's Computer

  1. Download and install node.js.
  2. Download, extract, and modify this source code, or copy all the modified source code from your computer to a folder on their computer.
  3. Open up a terminal/command window.
  4. Change to the directory where the source code files are located.
  5. Run the following command to install dependencies and install it as a CLI app.
npm install
npm install -g .

Last, add instructions to your loved one's computer to open up a terminal/command prompt window and type heybuddy (or whatever you defined as your app in the package.json file).

Hope this helps you touch someone's heart and let them know you love them! ❤

Updating

  1. Modify the source code to add/remove notes.
  2. Reinstall the CLI app same as installing it before.
npm install -g .

Uninstalling

npm uninstall -g notes-of-encouragement
You can’t perform that action at this time.