https://github.com/hannah68/moodlifter

A full-stack (PERN) app that improves the person's mood which I built as a solo project
https://github.com/hannah68/moodlifter

bcrypt css3 express figma jsonwebtoken nodejs postgresql prisma react typescript

Last synced: about 2 months ago
JSON representation

A full-stack (PERN) app that improves the person's mood which I built as a solo project

• Host: GitHub
• URL: https://github.com/hannah68/moodlifter
• Owner: hannah68
• Created: 2022-03-29T10:22:28.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-09T16:34:43.000Z (almost 2 years ago)
• Last Synced: 2023-03-09T22:46:39.941Z (almost 2 years ago)
• Topics: bcrypt, css3, express, figma, jsonwebtoken, nodejs, postgresql, prisma, react, typescript
• Language: TypeScript
• Homepage:
• Size: 99.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MoodLifter

> Moodlifter is an app that recommends appropriate content based on one's instantaneous mood.



## How does MoodLifter works

When in a good mood:

- MoodLifter shows the user a random quote

In case of low moods:

- depending on the selected feeling, MoodLifter uses the saved information provided by the user to remind them of ways that can improve how they feel. For instance, it suggests calling the favourite person as a potential remedy for one's low mood. 

- It also provides relevent articles, videos and motivational quotes.

In general:

- The users can create an account and save their favourite quote, video, motivational quotes and see them in their profile page.

- MoodLifter allows you to keep daily journals, (Journaling, whenever users feel good, is as beneficial as when they are in a low mood. Importantly, saving users' journals into a database whenever enables us to show them that they had good days as well as bad days).

## What was the problem

The idea of MoodLifter came to my mind when I wasn't in a good mood. I wanted to build an app that tracked the way I felt and allowed me to see how my mood would fluctuate over time. I was also looking for advice and helpful materials to keep up my spirits.

## How to run it

- Clone this repo and create an .env file

- Add your database using ElephantSQL inside .env file like below:

`DATABSE_URL="yourdatabase?schema=prisma"`




 `DATABASE_SHADOW="yourshadowdatabase?schema=shadow"`

 


 `SECRET="thisismysecret"`

 

 - Then run `npm ci`

 - Run `npm run devstart`

## Tech stack and methods Used

- Used **React, Typescript, Node.js, Express, PostgresSQl, Prisma ORM**.

- Developed **user stories** to capture the app's features from an end-user perspective

- Utilized **Kanban board** to track progress and **Figma** for app design

- Created an **ERD diagram** to build a relational database. ERD in Whimsical

- Implemented **bcrypt** and **JWT** for authentication

- Employed **ElephantSQL** cloud service for database

- Applied **React Router** for UI navigation

## Future improvements

1. Currently, a user can select one feeling at a time. A future improvement would be the ability to select multiple feelings and to provide relevant materials based on the all the selections.

2. There is an ability for the user to save their favourite quotes, articles and videos on their profile page to read or watch them later. Because of time limitations, I used state instead of storing them in DB.

3. Another feature that needs to be added is tracking the user's mood. It means that users would be able to see how their moods varied during a week at the end of each week.

4. At the moment users can't share their positive moment with other users in the MoodLifter Forum.This feature is under construction.

## Limitations

- There are limited materials for suggesting to users. I didn't find an external API to use for materials, except for the random quotes, for which I used Advice Slip.