vibe check
A journaling app including both long and short-form journaling as well as charts so you can check your vibe over time.
Explore the docs »
View Demo (coming soon)
Table of Contents
About The Project
Our team wanted to build an app that allowed us to check in on our own experiences throughout the day (via short-form journaling) and provide a platform for longer form journal entries to let us reflect on a broader time period. As a result, vibe check was born.
Our goals:
- Enable short-form journaling and a small "vibe check" for users to quickly enter in how they're feeling in the moment and keep living their life
- Create an intuitive long-form journaling experience for those times when you have more to reflect on (e.g., at the end of the day, every few days, or each week) ** This includes accounting for an offline experience where users might have written down their journal and wanted to upload it to the platform by taking a picture of it
- Reflect on the vibe rating you provided over time and see which journal entries or moments had more positive or negative vibes associated with them
Built With
This project was built using a variety of frameworks and tools, but we will focus on the main ones below:
Getting Started
To get a local copy up and running follow these simple example steps.
Prerequisites
- npm
npm install npm@latest -g
Installation
-
Clone the repo
git clone git@github.com:2206-fsa-best-team/VibeCheck.git -
Install NPM packages
npm install -
Run the following command to build the app
npm run start -
Navigate to localhost:8080 on your browser (note: you will not be able to access Google Cloud Vision running the app locally)
-
Log in with the following demo credentials or enter your own credentials and sign up Email: amaan.lakhani5+8@gmail.com Password: 123456
-
Enjoy!
Usage
Installing the app
Tap on the install to home screen button on the bottom of your screen
Confirm the installation
Navigate to the app from your home screen and open the app
You're all set!
Adding a Moment
Adding a Journal Entry
Adding a Journal Entry via written document
Viewing your vibes over time
Proof of Concept
- Create a Progressive Web Application in React✔
- Connect the app to Supabase ✔
- Enable Authentication via Supabase ✔
- Set up a PostgresQL database ✔
- Display all moments and individual moments ✔
- Add new moments ✔
- Set up navigation for moments and journal entries ✔
MVP
- Display all journal entries and individual journal entries ✔
- Add all journal entries ✔
- Edit / Delete moments and journal entries ✔
- Secure routes and reading moments / journal entries for each user ✔
- Enable camera usage in app ✔
- Enable camera capture of written journal entries using Google Cloud Vision ✔
- Highlight low-confidence words from written journal entries ✔
- Create charts based on vibe data for moments and journal entries ✔
- Enable filtering for moments and journal entries ✔
- Enhance responsiveness throughout all components to account for desktop and mobile usage ✔
- Deploy the app via Heroku (later Render) ✔
- Enable continuous integration using Heroku (later Render) and Github ✔
Long-term Vision
- Implementing NLP and incorporating sentiment analysis into the vibe values
- Graphing NLP sentiment analysis over time
- Provide more informed analyses of what trigger words are associated with "good" or "bad" vibes
License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
Amaan Lakhani - Github - LinkedIn - Email
Daniel Jacobson - Github - LinkedIn - Email
Evan Forde Barden - Github - LinkedIn - Email
Nicholas Angelopoulos - Github - LinkedIn - Email
Project Link: vibe check