Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devmount/you-can-quit
A tool to support your progress in quitting whatever your bad habit is.
https://github.com/devmount/you-can-quit
dexie earn-achievements habit indexeddb stats vuejs2 webapp webapplication
Last synced: 10 days ago
JSON representation
A tool to support your progress in quitting whatever your bad habit is.
- Host: GitHub
- URL: https://github.com/devmount/you-can-quit
- Owner: devmount
- License: mit
- Created: 2018-07-08T08:42:10.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T07:29:24.000Z (about 1 month ago)
- Last Synced: 2024-10-11T07:43:37.088Z (26 days ago)
- Topics: dexie, earn-achievements, habit, indexeddb, stats, vuejs2, webapp, webapplication
- Language: Vue
- Homepage: https://youcanqu.it
- Size: 3.58 MB
- Stars: 68
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# you-can-quit
[](https://github.com/devmount/you-can-quit/releases)
[](https://github.com/devmount/you-can-quit/commits/master)
[](./LICENSE.md)
[](./.github/CONTRIBUTING.md)
This app is a tool to track your progress and encourage you on the way of quitting a bad habit. In a simple calendar view, you can set past days _successful_ or _failed_. Based on this data, you can see encouraging stats about the number of days you succeeded in. Plus you can earn special achievements to reach different goals and keep you motivated on your way.
**you**-**c**an-**q**uit in short: **UCQ**, which also means (if you pronounce it): You Seek You. It's about you, making an impact on your own life.
This web app is based on Vue.js and Dexie.js.
> ℹ This app values privacy. The data isn't meant to be synchronized between different devices, therefore local browser storage (IndexedDB) is used to store your data. However you have the possibility to export your data and import it on another browser or device.
## Features
- 📅 Simple month and year views to see successful and failed days (and possible patterns) at one glance
- 📈 Stats section showing current and longest streak (successful days in a row) and the total number of successful days
- 🏆 Earn encouraging and funny achievements by reaching various goals, see progress of each achievement
- 🌐 UI supports multiple languages (currently only English and German)
- ⌨ Navigation with shortcuts:
- ← / → to go to previous/next month
- CTRL+← / CTRL+→ to go to previous/next year
- R to reset to current month
- 💾 Provides administration section to backup, import or clear database
- ⚡ Made for offline usage, the data is stored only in your local browsers
- 🔒 Values privacy - no synchronisation of data around the web
## Get started
Just head over to and start your journey.
## Build it yourself
1. Get all files
```bash
git clone https://github.com/devmount/you-can-quit
```
2. Install all dependencies using [Yarn](https://yarnpkg.com)
```bash
cd you-can-quit
yarn
```
3. Run the app by ...
... either run the `you-can-quit/dist/index.html` in your browser, e.g.
```bash
firefox dist/index.html&
```
... or start the development server with hot reload at localhost:8080
```bash
yarn serve
```
... or make the production build with minification yourself
```bash
yarn build
```
## Upgrade from 0.x to 1.x
The breaking change in version 1.x is, that the database was switched from Firebase to IndexedDB. This means, it's no longer compatible with your current data. If you rather want to migrate your data instead of starting from scratch (depends on how much days you already used this app), you can do the following:
1. Export your Firebase data into a local `.json` file in the following format:
```json
{
"2019-02-02": 1,
"2019-07-25": -1,
"2019-01-10": -1,
"2019-11-09": 1
}
```
The order of dates doesn't matter. If you have any problems to do so, please [create an issue](https://github.com/devmount/you-can-quit/issues/new?template=bug_report.md).
2. Update app files and dependencies
```bash
cd you-can-quit
git pull
yarn
```
3. Run the app (see instructions above in the *Get started* section) and import this data file in the administration section at the bottom.
---
you-can-quit is completely free to use. If you enjoy it, please consider [contributing](.github/CONTRIBUTING.md), [donating via Paypal](https://paypal.me/devmount) or [become a sponsor](https://github.com/sponsors/devmount/) for further development. :green_heart: