Skip to content

merogersdev/peace-of-mind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Peace of Mind

Peace Of Mind Screenshot

Quick Summary

BrainStation Web Development Bootcamp Capstone Project. Utilizes SASS/SCSS, React, JWT Tokens, Vite, Node, Express and a PostgreSQL Database. Demo is deployed to a Google Cloud VM running Ubuntu Server.

Goal

Peace of Mind is an application meant to assist in the day-to-day self-care and mental health of the user by providing an all-in-one solution for journaling and daily gratitude.

Core Features

  • Allows users to login and make journal entries, and keep track of their daily gratitudes.
  • Retrieves a random inspirational quote when you log in.

Initial Setup (Development)

Once you have cloned this repository to your computer, this application has the following prerequisites:

  • PostgreSQL Database, with login credentials
  • API Ninja Free API Key API Ninjas

  1. Copy /server/.env.example to /server/.env and populate with PostgreSQL credentials.

  2. To generate a JWT token, copy/paste the following command into your terminal and add the string to the JWT_SECRET in the /server/.env file

node -e "console.log(require('crypto').randomBytes(256).toString('base64'));"

  1. Sign up for a free API key at API Ninjas and paste it between the quotes in API_KEY='' in your /server/env file.

  2. Install backend packages

npm i

  1. Run inital database migration script (Creates tables and necessary columns)

npm run migrate

  1. Run the following command in your terminal to start the backend server.

npm run dev

  1. In another terminal, cd into the 'client' directory and install the frontend packages.

npm i

  1. Run the client development server.

npm run dev

  1. (Optional) To create a production build of the client files, run:

npm run build

Tags

HTML5 SASS JavaScript React JWT Express.js NodeJS Jest Testing-Library Postgres Ubuntu Docker Google Cloud GitHub Actions