Skip to content

BarrySong97/Breeze

Repository files navigation

Breeze

1684741395094.png

Breeze is a simple app to track your habit.

Local Version (Data Stored Locally)

Cloud Version (Data Stored on Server)

it provides 3 types of views for you to check on your habit trends.

Week view

p9NMSMT.png

Month view

Clicking on the date icon in the weekly view will bring up the monthly view.

p9NMMee.png

Year view

Clicking on the habit itself will open the yearly view.

1684741924723.png

Both the weekly and yearly views allow for check-ins (simply click on the corresponding date to check in), with the yearly view serving as a way to display the data for the entire year.

In the yearly view, you can see... 1684743578945.png

  • Start date of the check-in

  • Current streak of consecutive check-in days

  • Maximum consecutive check-in days (longest streak)

  • Total number of check-in days (sum of all signed-in days)

And two crucial charts:

  • Line graph 1684738134876.png
  • Heatmap 1684743660799.png

How to develop

There are two branches

  • main
    • work with backend
    • store data on server
  • local
    • store data in browser IndexDB by using dexie

setup

install

pnpm i

start up

pnpm run dev

build

pnpm run build

generating backend api files from swagger json by using openapi-typescript-codegen

pnpm run api:generate

// "api:generate": "openapi --input http://localhost:3000/api-json --output ./src/api --exportCore false"

.env

On main branch, we support Google login.

so, you have to create your own google oauth2 crendentials.

Then fill in VITE_GOOGLE_CLIENT_ID and VITE_GOOGLE_CALLBACK_URL in .env

see detials in .env.example

knowing more about .env in vite.

see Env Variables and Modes

deploy

main

We use jenkins to deploy.

So there is a jenkins file and dokckerfile.

local

You could simply use Vercel or Netlify to deploy.

Road Map

About

A simple and light weight habit tracker

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages