Skip to content
/ journ Public

A command-line Journaling app, based on the functionality of 750 words.

Notifications You must be signed in to change notification settings

AlamarW/journ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Why journ?

journ is a terminal-based journaling app meant to keep you in your terminal. As I've progressed in my development journey, I realized that developers want to stay in their editor/IDE of choice as long as possible. journ is meant to work with your default editor of choice so that you can go from journaling to development all from the ease of the terminal. All while helping you stay accountabile with a daily word goal and streak tracker.

About the Project

journ started as a project to mimic much of the functionality of the website 750words.com but to make the data local for the users instead of in a cloud. It started to feel weird to me with how much personal stuff I was journaling with on a site with a backend that was not in my control.

Since conception of the project, I've deviated a bit from the clone of 750words.com goal and am dedicating myself to a "fully featured" journaling app in the terminal. The core of journ is that I don't want to take your default text editor from you. People who like to do things in their terminal have their editor of choice (I use neovim btw) and so journ defaults to whatever you have it set up as.

It's helpful to have a word counter in your text editor of choice, but journ will take care of that for you if not (just not as elegantly)

The Completion of below will make journ official v1

To Do List

  • Fully implement daily tmp file for editing
  • User login
    • Prevent journaling to anyone logged out
    • Journal Session logging
    • User goals fully implemented
    • Storage of data based on User Login
    • sqlite database uses stored user idea
      • User can update their goals
  • Journaling streak
  • Implement default to user defined text editor
  • Make password optional
  • Add current journ data (word count mostly)

Bug List

  • Changing login system created error when user says they've logged in if db is empty
  • System allows for overwriting of user names
  • Current implementation creates difficult loop if register process starts and user isn't sure they want the selected login, not sure how to fix right now. Will have to replace the recursive calls with while loops.
  • journal sessions are not currently tied to user/any user can access any other users' current journ
  • todays_journ breaks when user hasn't journaled yet
  • Streak incremented multiple times a day
  • Registration followed by journ breaks system
  • other users can still access another's daily journ

About

A command-line Journaling app, based on the functionality of 750 words.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages