Home

Journal App - GitHub Wiki

Welcome to the Journal App Wiki! This comprehensive guide will help you understand, install, and utilize the Journal App efficiently. Whether you are a beginner or an advanced user, this wiki provides everything you need to get started.

---

Overview

The Journal App is a command-line journaling tool that allows users to write, save, and retrieve journal entries effortlessly. Built with simplicity in mind, it focuses on text-based input and file storage to ensure accessibility across all platforms without the need for databases or cloud storage.

Why Choose Journal App?

• Lightweight and fast
• No login or internet connection required
• Works across Windows, macOS, and Linux
• Completely open-source
• Easy to modify and extend

---

Features

• Minimalistic Design – No distractions, just write.
• Text File Storage – Entries are stored as plain text files for easy access.
• Directory Navigation – Organize journals by folders and categories.
• Error Handling – Prevents accidental file overwrites and provides warnings.
• Future-Proof – No proprietary formats, ensuring longevity.

---

Installation Guide

System Requirements

• Python 3.x
• Command Line Terminal (CMD, PowerShell, Bash, or Terminal)

Step 1: Download the Repository

git clone https://github.com/Aarooshsaifanboy322/Journal.git

Step 2: Navigate to the Project Directory

cd journal-app

Step 3: Run the Application

python main.py

Running the GUI Version

Run the new GUI version with this command:

C# JournalApp.exe

---

How to Use

Creating a New Journal Entry

1. Open the application.
2. Enter a directory where journals should be stored.
3. Choose to create a new journal.
4. Enter a name for your file.
5. Type your journal entry.
6. Confirm to save the file.

Viewing Previous Journal Entries

1. Open the application.
2. Enter a directory where journals are stored.
3. Choose to view a journal.
4. Enter the file name.
5. The app will display the file contents.

Example Session

Dir ... /Users/YourName/Documents/Journals
Would you like to view a previous journal? (Yes/No) ... Yes
File: my_journal.txt
(This will display the contents of the journal entry.)

---

Troubleshooting

Common Issues & Fixes

1. File Not Found Error – Ensure the file exists and that you are in the correct directory.
2. Permission Denied Error – Check file permissions and run the script with proper access rights.
3. Python Not Recognized – Ensure Python is installed and added to your system’s PATH.

---

Frequently Asked Questions

1. Can I use this app on my phone?

Currently, the Journal App is designed for desktop use. However, you can use Termux on Android to run it.

2. Can I sync journals across devices?

You can use a cloud storage service like Google Drive or Dropbox to sync journal entries manually.

3. Is there a GUI version of the Journal App?

Not yet, but I may add a graphical interface in the future.

---

Future Plans

Planned Features:

• Create a GUI version of the app.
• Add a search bar and a place where all the journals are displayed.

---

License

The Journal App is released under the MIT License, meaning you are free to use, modify, and distribute it as you like.