diff --git a/README.md b/README.md index f4da3c4..e8cbbb0 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,136 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +
-## Getting Started +Banner -First, run the development server: +[pomodoro-re.vercel.app](https://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](https://www.codefactor.io/repository/github/thienguen/pomodoro-re/badge)](https://www.codefactor.io/repository/github/thienguen/pomodoro-re) + +
+ +# Preview โ˜๏ธ + +
+ +Banner + +
+ +## Getting Started ๐ŸŽฒ + + + + +Set up the environment variables file with the following variables. (Optional) ```bash -npm run dev -# or -yarn dev -# or -pnpm dev + 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) โ˜ข๏ธ + +```bash + # install dependencies + npm install + + # run the development server + npm run dev + # or + yarn dev + # or + pnpm dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +# Features โœ’๏ธ + +- [x] Discord Presence +- [x] useSound +- [x] Theme options +- [x] Reponsive (??) + +# Project Folder Structure ๐Ÿ’€ + +Welcome to the project's folder structure! Below is an organized representation of the directories and subdirectories: + +```bash +## 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 + +- [Next.js](https://nextjs.org/) +- [React.js](https://reactjs.org/) +- [Tailwind CSS](https://tailwindcss.com/) +- [DaisyUI](https://daisyui.com/) + +# ๐Ÿ“ˆ Statistic + +
+ +![Alt](https://repobeats.axiom.co/api/embed/7ceb93769b2e01daa7c2395d02483a6841370d81.svg "Repobeats analytics image") -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +
-## Learn More +# Issues ๐Ÿงป -To learn more about Next.js, take a look at the following resources: +The repo currently facing two known bugs from Next.js -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- [ ] [Server run out of memory](https://github.com/vercel/next.js/issues/46756) +- [ ] [Non Post Server Error](https://github.com/vercel/next.js/issues/53882) -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +# Aight ๐Ÿง -## Deploy on Vercel +- 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](https://pomofocus.io/) and [JoseMurlloc](https://github.com/JoseMurilloc/clone-pomofocus) -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +# ๐Ÿ“ License & Forking/Cloning -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +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. diff --git a/public/preview/amongus.png b/public/preview/amongus.png new file mode 100644 index 0000000..a0bc419 Binary files /dev/null and b/public/preview/amongus.png differ diff --git a/public/preview/preview-pomo.gif b/public/preview/preview-pomo.gif new file mode 100644 index 0000000..1935786 Binary files /dev/null and b/public/preview/preview-pomo.gif differ