Stoic cafe

This project helps you with your morning stoic meditation.
It provides services for storing, listing, adding quotes and attaching thoughts that come to your mind when meditatin on the quotes.
Report Bug · Request Feature

Table of Contents

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

About The Project

This is my playground, nothing serious, just having fun and learning.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

You may try to build this project locally and start two containers: application container and postgresql container. See docker-compose.yaml for details.

Prerequisites

• docker
• maven
• git

Installation

1. Clone the repo

   git clone https://github.com/kamchy/stoic_cafe.git

2. Build the app

   mvn clean package

3. Build images and run with

   docker compose up

(back to top)

Usage

The goal of this project is to expose yourself to ancient wisdom of stoic philosophers. As an everyday practice, you should pick a random quote (or whatever quote that resonates with the state of your mind) and write down all the things that come to your mind. This exercise will help you stay focused and will bring stoic wisdom into your life, making you much calmer, much balanced and much happier human being.

(back to top)

Roadmap

• Add frontend
  • display random quote
  • allow to change it
  • display related thoughts
  • allow to add thought related to a quote
• Allow browsing quotes
  • with attached thoughts
• Allow browsing thoughts
  • display quote (if athought is related to it)
• Allow adding unrelated thoughts
  • export quotes and thoughts

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

Project Link: https://github.com/kamchy/stoic_cafe

Blog posts:

• https://kamilachyla.com/en/posts/docker-example
• https://kamilachyla.com/en/posts/docker-volumes

(back to top)