Johnny B's CLI Journal

Super Simple CLI Journal
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

I wanted a personal journal app where I could control my own data. I didnt want any fancy features or distractions. So I created Johnny B's CLI Journal. This uses pythons sqlite3. No need to setup a database when running the first time it will create the nessesary folder and file.

(back to top)

Built With

(back to top)

Getting Started

Installation

1. Clone the repo

   git clone https://github.com/john-blanton-jr/Johnny-Bs-CLI-Journal.git

2. Create Virtual Environment

   cd Johnny-Bs-CLI-Journal
    python -m venv .venv 
   
    # windows
    .venv\Scripts\Activate.ps1
   
    # MacOS/Lunix 
    source .venv/bin/activate

3. Install Requirements

   pip install -r requirements.txt

4. Run

   Python app.py

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

John - hello@johnblanton.com

(back to top)

Acknowledgments

Rich

(back to top)