/SentiJournalApp

This React.js project utilizes Firebase backend and the DistilBERT model for sentiment analysis, enabling a digital journal app to analyze users' entries, identify emotional patterns, and prompt reflective questions for enhanced mental health insights.

Primary LanguageJavaScript


Logo

SentiJournal

An intelligent journal to review your emotional journey!
Explore the docs »

View Demo · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Contact
  6. Acknowledgments

About The Project

Home Screen Shot Analysis Screen Shot

This project proposes to build a digital journal application that uses natural language processing to perform a sentiment analysis on journal entries to provide users more insights on their mental health over time. The journal will be able to have many features that take this beyond a traditional journal, including analyzing the emotional tone of the user’s entries, identify patterns in the user’s emotions and experiences, and prompt users with questions to encourage deeper reflection.

(back to top)

Built With

These are the major frameworks/libraries used to bootstrap my project.

  • React
  • Tailwind-CSS
  • Firebase
  • npm

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to use the software and how to install it.

  • npm 
    npm install npm@latest -g

Installation

Below is an example of how you can install and set up the app on your local machine.

  1. Clone the repo 
    git clone https://github.com/caowens/SentiJournalApp.git
  2. Install NPM packages 
    npm install
  3. Start the environment to make sure everything is running properly 
    npm start

(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)

Contact

Alex Owens (Developer) - caowens256@gmail.com

SentiJournal email - sentijournalforall@gmail.com

Repo Link: https://github.com/caowens/SentiJournalApp

Project Link: https://sentijournal-fb-app.web.app/

(back to top)

Acknowledgments

These are resources I've found helpful and would like to give credit to.

(back to top)