Skip to content

Latest commit

 

History

History
114 lines (91 loc) · 4.14 KB

README.md

File metadata and controls

114 lines (91 loc) · 4.14 KB
Raw

PomoPets

PomoPets is an incentivized Pomodoro timer. Begin your focus session with a mysterious, hatchable egg and upon completing your focus session, you are rewarded with a cute digital pet!

A Lighthouse Labs project by Justin Lam, Rhea Azarraga, and Arushi Katyal.

Features

  • ⭐ Allows users to choose and name their own digital pets
  • ⭐ Has a Pomodoro timer that has 25 minute focus sessions and 5 minute breaks
  • ⭐ Users can start and reset the timer as they wish
  • ⭐ Users can choose their area of focus for the timer
  • ⭐ Statistics page tracks number of Pomodoro sessions completed by area of focus
  • ⭐ Dark Mode
  • ⭐ Deployed on Netlify and Heroku

Future Features

  • Integrate Spotify
  • Unlock new pets based on number of Pomodoro sessions completed
  • Adding more page themes
  • Responsive design for app to be used on any device
  • Audio notification when focus session is completed

Screenshots

Homepage

"pomopets homepage"

Homepage (Dark Mode)

"pomopets homepage dark mode"

Choose your PomoPet

"pomopets pets"

Choose your PomoPet (Dark Mode)

"pomopets pets dark mode"

Timer

"pomopets timer"

Timer (Dark Mode)

"pomopets timer dark mode"

Statistics

"pomopets stats

Statistics (Dark Mode)

"pomopets stats dark mode"

Getting Started

Setting up the Server

  1. Go to pomo-api: cd pomo-api
  2. Create the .env by using .env.example as a reference: cp .env.example .env
  3. Create a database in PostgreSQL named pomo_db
    • CREATE DATABASE pomo_db;
  4. Update the .env file with your correct local information
    • PORT: 3030
    • DATABASE_URL="postgresql://USER:PASSWORD@localhost:5432/pomo_db"
  5. Install dependencies: npm i
  6. Create database: sequelize db:create
  7. Run migrations: npm run migrate or npx prisma migrate dev --name init
  8. Run the server: npm start
  9. Go to localhost:3030

Setting up the Client

  1. Go to pomo-react: cd pomo-react
  2. Update proxy in the package.json with the port you used for the server
    • "proxy": "http://localhost:3030",
  3. Install dependencies: npm i
  4. Run the app: npm start

Dependencies

Server-side

"@prisma/client": "^3.9.2",
"prisma": "^3.9.2",
"bcryptjs": "^2.4.3",
"bundle": "^2.1.0",
"cookie-parser": "~1.4.4",
"cors": "^2.8.5",
"debug": "~2.6.9",
"dotenv": "^16.0.0",
"ejs": "^3.1.6",
"express": "~4.16.1",
"http-errors": "~1.6.3",
"morgan": "~1.9.1",
"pg": "^8.7.3"

Client-side

"@faker-js/faker": "^6.0.0-alpha.7",
"axios": "^0.25.0",
"bootstrap": "^5.1.3",
"chart.js": "^3.7.1",
"lodash": "^4.17.21",
"react": "^17.0.2",
"react-bootstrap": "^2.1.2",
"react-calendar": "^3.7.0",
"react-chartjs-2": "^4.0.1",
"react-circular-progressbar": "^2.0.4",
"react-dom": "^17.0.2",
"react-router-dom": "^6.2.1",
"react-scripts": "5.0.0",
"sass": "^1.49.7",
"web-vitals": "^2.1.4"

To drop and recreate the database

  1. Connect to PostgreSQL using psql
  2. Drop the database by running DROP DATABASE pomo_db;
  3. Create the database by running CREATE DATABASE pomo_db;
  4. Run npm run migrate or npx prisma migrate dev --name init
  5. Run npx prisma db seed