Journal Bot

About The Project

JournalBot is a chatbot companion that provides a safe and confidential space for you to express your thoughts and feelings. By leveraging the power of large language models (LLMs), JournalBot offers a conversational approach to journaling. You can interact with the chatbot as you would a therapist or friend, and receive prompts and support tailored to your responses.

Getting Started

Start typing your thoughts and feelings in the chat window. JournalBot will respond with prompts and continue the conversation. We are committed to providing a valuable tool for emotional well-being and welcome your feedback!

Installation Requirements

This is the server side repo. For the client side, visit: https://github.com/anagelberg/journal-bot-client

1. Get a free API Key at [https://cohere.com/](Sign up at https://www.cohere.ai/ to obtain an API key)
2. Clone the repo

   git clone https://github.com/github_username/repo_name.git

3. Install packages

   pip install -r requirements.txt

4. Enter your API in .env file

   const CO_API_KEY = 'ENTER YOUR API';

(back to top)

Usage

• Express yourself freely in a safe and supportive environment.
• Gain insights into your thoughts and feelings.
• Identify patterns in your mood and emotional state.
• Develop healthier coping mechanisms.
• Feel empowered to take charge of your emotional well-being.

(back to top)

Features

• Journaling Support: Users can type their feelings and thoughts into the chatbot, treating it as a virtual journal.
• Prompted Responses: The chatbot responds with prompts generated using the Cohere API, providing therapeutic support and friendly interaction.
• Sentiment Analysis: The chat history is analyzed using a language machine learning model to determine sentiment and tone, providing insights into the user's emotional state.
• Accessibility: Anyone with an internet connection can access JournalBot, regardless of location or socioeconomic background.
• Affordability: JournalBot is a free-to-use tool for improving your mental health.

(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".

(back to top)

Acknowledgments

• NWPlus Hackathon Organizers for providing a platform to foster innovation and collaboration.
• Cohere.ai for offering their powerful API that enables natural language understanding and generation, making JournalBot's conversational capabilities possible.

(back to top)