slococo-uni
/
breakoften
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
63 Commits 1 Branch 0 Tags 2.3 MiB
Svelte 72%
TypeScript 18.2%
JavaScript 7.3%
HTML 2.3%
CSS 0.2%
Go to file
Santiago Lo Coco 3c72765abc Reformat schema 2024-05-18 23:37:39 +02:00
.github/workflows Update ci.yml (x4) 2024-05-18 17:55:29 +02:00
.husky Add husky 2024-04-23 21:00:55 +02:00
prisma Reformat schema 2024-05-18 23:37:39 +02:00
src Add service-worker.js 2024-05-18 22:56:37 +02:00
static Add auth and external API 2024-04-24 17:41:31 +02:00
.env.example Replace Supabase with Vercel database 2024-05-18 23:37:01 +02:00
.gitignore Revert changes 2024-04-23 19:17:27 +02:00
.npmrc Add initial files 2024-04-23 14:44:27 +02:00
.prettierignore Add navbar and use localStorage for theme 2024-04-24 14:17:43 +02:00
.prettierrc Fix lots of bugs and refactor 2024-04-23 17:15:16 +02:00
README.md Replace Supabase with Vercel database 2024-05-18 23:37:01 +02:00
package-lock.json Use superforms and zod 2024-05-09 11:47:46 +02:00
package.json Use superforms and zod 2024-05-09 11:47:46 +02:00
postcss.config.js Fix lots of bugs and refactor 2024-04-23 17:15:16 +02:00
svelte.config.js Add navbar and use localStorage for theme 2024-04-24 14:17:43 +02:00
tailwind.config.js Add navbar and use localStorage for theme 2024-04-24 14:17:43 +02:00
tsconfig.json Add navbar and use localStorage for theme 2024-04-24 14:17:43 +02:00
vite.config.ts Fix lots of bugs and refactor 2024-04-23 17:15:16 +02:00

README.md

BreakOften

BreakOften is a cutting-edge web application designed to help users combat computer vision syndrome by encouraging regular breaks. Built with Svelte, BreakOften offers a seamless and customizable user experience to ensure you maintain a healthy balance between work and rest.

Why BreakOften?

In today's digital age, prolonged screen time is inevitable. BreakOften is your personal wellness assistant, ensuring you take necessary breaks to rest your eyes and maintain productivity. Whether you're a student, professional, or avid gamer, BreakOften is tailored to fit your lifestyle.

Features

  • Frequent mini breaks: Receive reminders for short breaks every 20 minutes and 20 seconds to rest your eyes.
  • Long breaks: After three mini breaks, enjoy a longer 5-minute break to recharge fully.
  • Flexibility: Skip or postpone breaks according to your needs without disrupting your workflow.
  • Customization: Personalize your break schedule and timer settings. Logged-in users have their preferences saved in their profile, while others can use localStorage.
  • Alerts: Get notified with sound and visual alerts to ensure you never miss a break.
  • Integration with Prisma and Vercel database: Secure user authentication and storage of user-defined variables like timer settings.
  • Theming: Choose from dark or light mode.
  • Offline support: Lost connectivity? No problem — you can still use the timer, thanks to caching with service-worker.js.
  • Fun extras: Enjoy a touch of culture with Shakespeare quotes on your profile page.

Getting started

Follow these steps to set up BreakOften on your local machine:

  1. Clone the repository:

    git clone https://github.com/se23m504/BreakOften.git
cd BreakOften

  2. Install dependencies:

    npm install

  3. Setup environment variables:

    Create a .env file with your DATABASE_URL. You can start by copying the example file and then modify it:

    cp .env.example .env

  4. Set up database:

    Push the Prisma schema to Vercel:

    npx prisma db push

  5. Run the development server:

    Start the server and open your browser:

    npm run dev -- --open