A full-featured CLI mood diary aimed to provide a user-friendly interface for journaling one's mood and activities through the terminal.
You can pick a name for your diary and yourself, be greeted with motivational quotes, keep track of your daily mood and much more!
This was made for learning purposes, using the service/repository pattern with dynamic polymorphism, singleton classes and dependency injection.
- CLI with menus to choose between different actions
- Write, edit, delete and read entries from any given date
- Name the diary and choose how you would like to be called
- Word counting features
- Average and most common mood tracking
- Edit the daily entry description with your default text editor
- List of random quotes on the main menu that can be changed/hidden
- Easy access to quotes list file to add more quotes to the main menu
- Easy access to JSON configuration file
- Create and delete entry categories
- Filter entry list by categories
- Export/back up all entries to a single JSON file to chosen path
- Import backup/exported entries into the diary
- Entry Schema validation
- Setup config file on first initialization
- "Factory Reset" options
- JSON storage Repository
- SQL storage Repository
- Encryption
git clone https://github.com/augustofrade/mood-diary-cli.git
cd mood-diary-cli
npm run create
Or you can run each step of the installation separately:
git clone https://github.com/augustofrade/mood-diary-cli.git
cd mood-diary-cli
npm install
npm run build
npm i -g
Just run the command moodiary in the terminal!
Upon executing the software for the first time, the user will be prompted to set basic info, such as their name, diary's name and which storage method they would like to use (JSON or SQL). Then, after the initial setup they will be prompted with the main menu unless either the diary or its configuration file (config.json) are deleted.
In the main menu, they can choose between several options and its actions.
Prompts the user to pick a date in the YYYY-MM-DD format and let them set the daily entry categories and day's mood and write its title and description. If they desire to, there's the option to review what was written and change it.
Writing the entry's description is done using the system's preferred text editor.
Lists available entries to the user and a few options:
- Filter by category
- Toggle dates/titles/moods
If an entry is selected, a screen with its information will be shown with all of its details.
Simply select an entry in the "List Entries" menu.
Simply select an entry in the "List Entries" menu and choose the desired action.
Show the following informations about the diary:
- Average mood
- Most common mood
- Sum of words written in all entries
Categories can be set to an entry during its creation or edition proccess.
Some categories are created by default upon the diary's creation.
It is possible to list the available categories, create or delete one by selecting Categories Settings in the Settings menu.
Quotes are stored on the headings.txt file located on the diary's directory and will be randomly shown to the user in the main menu unless it is set to not do so.
To add quotes (or manually remove it) open said file and create a new line and insert the desired text there. Each line is a different quote.
It is possible to reset (and recreate) the quotes list files by selecting Reset quote list on the Settings menu.
It is possible to export all the entries to a single JSON file by selecting the option Export and backup entries to JSON file in the Settings menu.
Simply select the action and pick a directory. The file will be created in the following name format: {directory}/diary_export_YYYYMMDDmmSS.json.
It is possible to import your entries to the diary from a exported JSON file by selecting the option Import from backup in the Settings menu and writing the file's full path.
Note: if there's entries that share the same ID (YYYY-MM-DD), the one in the diary will be overwriten by the one in the backup file.
It is possible to reset the settings by selecting Reset diary's settings in the Settings menu. By doing so, the diary first setup screen will be instantly prompted again.
This menu lists several options for the user:
- Change user's name
- Change diary's name
- Change date formatting (default: YYYY-MM-DD)
- Hide/Show quotes on main menu
- Categories Settings
- Import from backup
- Export and backup entries to JSON file
- Reset quote list
- Reset diary's settings
- Delete everything