/pomodoro-re

re-create pomodoro in my own way with nextjs, typescript and tailwind css. 💮

Primary LanguageTypeScript

Banner

pomodoro-re.vercel.app, Re-imagine Pomodoro in my own way
Using Next.js 13, enhanced with Tailwind, theme custom with daisyUI, powered by TypeScript, and seamlessly deployed via Vercel.

CodeFactor

Preview ☁️

Banner

Getting Started 🎲

Set up the environment variables file with the following variables. (Optional)

  git clone https://github.com/Thienguen/pomodoro-re.git

  # create .env file

  NEXT_PUBLIC_DISCORD_ID=
  NEXT_PUBLIC_EMAIL=

Next, run in the CLI (root folder) ☢️

  # install dependencies
  npm install

  # run the development server
  npm run dev
  # or
  yarn dev
  # or
  pnpm dev

Open http://localhost:3000 with your browser to see the result.

Features ✒️

  • Discord Presence
  • useSound
  • Theme options
  • Reponsive (??)

Project Folder Structure 💀

Welcome to the project's folder structure! Below is an organized representation of the directories and subdirectories:

## public
├── 📂 fav
├── 📂 icons
├── 📂 preview
└── 📂 sounds

## src code
├── 📁 app
│   └── 📄 layout.tsx
│   └── 📄 page.tsx
├── 📁 components
│   ├── 📁 footer
│   │   └── 📁 lanyard
│   │   └── 📄 index
│   ├── 📁 header
│   │   └── 📁 left-right
│   │   └── 📁 menu
│   │   └── 📁 modal
│   │   └── 📄 index
│   ├── 📁 home
│   │   └── 📄 index
│   ├── 📁 provider
│   │   └── 📄 ContextProvider.tsx
│   ├── 📁 setting
│   │   └── 📄 index
│   ├── 📁 ui
│   │   └── 📁 themes
├── 📁 hooks
│   └── 📁 pomodoro
│   └── 📄 useXXX.ts 
└── 📁 lib
    ├── 📁 type
    └── 📁 util

## css
├── 📁 styles
│   ├── 📄 global.css
│   └── 📄 cursor.css

Tech Stack

📈 Statistic

Alt

Aight 🐧

  • I still having the original Pomodoro before the current one, not sure what happened?
  • Was intended to do a reverse-engineer, turns to re-imagine.
  • Project was done in: 20 hours
  • it turns out, aight.
  • Heavily inspired by Pomofocus and JoseMurlloc

📝 License & Forking/Cloning

All code in this repository is licensed under the GNU Affero General Public License v3—see the LICENSE file for more information. Please remove all of my personal information and related stuff. If you want to use this repo. This is source-available. Feels free to do so and give it a star.