Skip to content

Commit

Permalink
chore: update README and add demo showcase
Browse files Browse the repository at this point in the history
  • Loading branch information
slavikdenis committed Jun 27, 2023
1 parent 040fd65 commit 1639777
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 21 deletions.
36 changes: 15 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
# Vape Timer
# Vape Timer 🍀

# Roadmap
A minimalistic offline-first timer [Progressive web app](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps) for your vaping sessions.

- [x] initialize with NextJS
- [x] make app as PWA
- [x] add timer functions with START/PAUSE/RESET actions
- [x] add circle countdown timer
- [x] show data about session
- [x] add Vibration API
- [x] add Screen Wake Lock API
- [x] add settings with options to configure timer and APIs used (time lengths, vibrate on/off, screen lock on/off)
- [x] add functionality to timers to be preserved running when tab is inactive
- [x] add unit tests
- [x] add app e2e tests
- [x] add settings e2e tests
- [ ] add gif to README of functions
- [ ] ? add page with motivation/description
- [ ] add animated background
- [x] add lazy loading of components
- [ ] add analytics
- [x] add auto stop function
- [x] add prompt when leaving app while timer is running
## Showcase

![Showcase GIF](https://github.com/slavikdenis/vape-timer/blob/main/demo/showcase.gif?raw=true)

## Features

- Offline first
- Installable
- Dark mode
- Customizable
- Auto Stop timer
- Screen Wake Lock
- Vibration
Binary file added demo/showcase.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 1639777

@vercel
Copy link

@vercel vercel bot commented on 1639777 Jun 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

vape-timer – ./

vape-timer-slavikdenis.vercel.app
vape-timer-git-main-slavikdenis.vercel.app
vape-timer.vercel.app

Please sign in to comment.