Skip to content

Commit

Permalink
🉐update: readme, and public
Browse files Browse the repository at this point in the history
  • Loading branch information
thienguen committed Sep 19, 2023
1 parent dbdd1f3 commit db3fa5d
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 18 deletions.
138 changes: 120 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
<div align="center">

## Getting Started
<img src="public/preview/amongus.png" alt="Banner" style="width: 150px; border-radius: 50%; filter: invert(1);">

First, run the development server:
[pomodoro-re.vercel.app](https://pomodoro-re.vercel.app/), Re-imagine Pomodoro in my own way<br>
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)

</div>

# Preview ☁️

<div align="center">

<img src="public/preview/preview-pomo.gif/" alt="Banner" >

</div>

## 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

<div align="center">

![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.
</div>

## 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.
Binary file added public/preview/amongus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/preview/preview-pomo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit db3fa5d

Please sign in to comment.