CLI Journal app made in Ruby

A small journal app, my first Ruby creation.

What is it?

• Allows users to write entries with optional titles
• The program will auto create a txt file with the date of the entry when it's closed
• Entries can be edited or removed
• Style inspired by Alien Isolation's terminals (Don't worry, no evil alien will chase you... yet. Maybe I'll add that feature in the future)
• Added export support for PDF, Markdown, and Plain Text!
• Users can now select which journal to load or create. data is stored locally.

This project is very small, but I have plans for it

What I'd like to add

• Probably should be able to choose the name of the file you're saving ✅ Done!
• Testing manually proved difficult as the program grows. I must learn and add tests before anything else.(at testing framework perhaps that can be added to as features as added) ✅ Done!
• Swap journal in the loop menu✅ Done!
• Choose export filename ("Save As" dialog when exporting)
• Journal class could use a manager to make main less of a clutter ✅ Done! I imagine as I discover more needs I'll make more smaller files and methods as I grow.
• Save in different file formats ✅ Done!
• Encryption (because some thoughts need protecting from the Nostromo's crew)
• Evil Alien showing up now and then (maybe allow the user to turn that off)
• I want this to be useful for everyone, so some user interface, be it TUI or GUI (but it'll still look like Alien terminals)
• I'm open to suggestions!

Installing

1. Git clone this repo:

git clone https://github.com/Redsskull/journal
cd journal

2. Configure Bundler:

bundle config set --local path 'vendor/bundle'

3. Install dependencies:

bundle install

4. Run the app:

ruby main.rb

Testing

I used MiniTest for testing, and I used old fashion unit tests

ruby test/run_all.rb

Will run my tests, and of course using Ruby to run an individual test file can be done as well. See test/test.md for testing philosophy and approach.

This app requires Ruby installed