|
1 | | -<div align="center"> |
2 | | -<img width="1200" height="475" alt="GHBanner" src="https://github.com/user-attachments/assets/0aa67016-6eaf-458a-adb2-6e31a0763ed6" /> |
3 | | -</div> |
| 1 | +# ⏱️ **ChronoMind** |
4 | 2 |
|
5 | | -# Run and deploy your AI Studio app |
| 3 | +A clean and modern time-management app featuring a **Stopwatch** and **Countdown Timer**. |
| 4 | +Designed for productivity, focus, and simplicity. |
6 | 5 |
|
7 | | -This contains everything you need to run your app locally. |
| 6 | +--- |
8 | 7 |
|
9 | | -View your app in AI Studio: https://ai.studio/apps/drive/1lHQoXsnBF9lnm0rNXGDpCPMcpkGXa9tW |
| 8 | +## 🌟 **Features** |
10 | 9 |
|
11 | | -## Run Locally |
| 10 | +* **Stopwatch** |
12 | 11 |
|
13 | | -**Prerequisites:** Node.js |
| 12 | + * Start / Pause / Reset |
| 13 | + * Millisecond-accurate timing |
| 14 | + * Smooth UI transitions |
| 15 | +* **Countdown Timer** |
14 | 16 |
|
| 17 | + * Custom time input |
| 18 | + * Start / Pause / Reset |
| 19 | + * Audible or visual end alerts (optional depending on your features) |
| 20 | +* **Responsive UI** — Works on desktop & mobile |
| 21 | +* **Fast** — Built with Vite + React + TypeScript |
| 22 | +* **Lightweight & Minimal** design |
15 | 23 |
|
16 | | -1. Install dependencies: |
17 | | - `npm install` |
18 | | -2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key |
19 | | -3. Run the app: |
20 | | - `npm run dev` |
| 24 | +--- |
| 25 | + |
| 26 | +## 🚀 **Tech Stack** |
| 27 | + |
| 28 | +* **React** |
| 29 | +* **TypeScript** |
| 30 | +* **Vite** |
| 31 | +--- |
| 32 | + |
| 33 | +## 📦 **Installation** |
| 34 | + |
| 35 | +Clone the repository: |
| 36 | + |
| 37 | +```bash |
| 38 | +git clone https://github.com/<your-username>/chronomind.git |
| 39 | +cd chronomind |
| 40 | +``` |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +## 🧩 **Run Locally** |
| 45 | + |
| 46 | +**Prerequisite:** Node.js installed |
| 47 | + |
| 48 | +1️⃣ Install dependencies |
| 49 | + |
| 50 | +```bash |
| 51 | +npm install |
| 52 | +``` |
| 53 | + |
| 54 | +2️⃣ Start the development server |
| 55 | + |
| 56 | +```bash |
| 57 | +npm run dev |
| 58 | +``` |
| 59 | + |
| 60 | +3️⃣ Open the app |
| 61 | + |
| 62 | +``` |
| 63 | +http://localhost:5173 |
| 64 | +``` |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## 🛠️ **Build for Production** |
| 69 | + |
| 70 | +```bash |
| 71 | +npm run build |
| 72 | +``` |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 🌐 **Deployment** |
| 77 | + |
| 78 | +ChronoMind is automatically deployed using **GitHub Pages** through GitHub Actions. |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## 📁 **Project Structure** |
| 83 | + |
| 84 | +``` |
| 85 | +Directory structure: |
| 86 | +└── albindavidc-chronomind/ |
| 87 | + ├── README.md |
| 88 | + ├── App.tsx |
| 89 | + ├── index.html |
| 90 | + ├── index.tsx |
| 91 | + ├── metadata.json |
| 92 | + ├── package.json |
| 93 | + ├── tsconfig.json |
| 94 | + ├── types.ts |
| 95 | + ├── vite.config.ts |
| 96 | + ├── components/ |
| 97 | + │ ├── CircularProgress.tsx |
| 98 | + │ ├── SmartSetup.tsx |
| 99 | + │ ├── StopwatchView.tsx |
| 100 | + │ ├── Tabs.tsx |
| 101 | + │ └── TimerView.tsx |
| 102 | + ├── public/ |
| 103 | + │ └── manifest.json |
| 104 | + ├── services/ |
| 105 | + │ └── geminiService.ts |
| 106 | + ├── utils/ |
| 107 | + │ └── time.ts |
| 108 | + └── .github/ |
| 109 | + └── workflows/ |
| 110 | + └── deploy.yml |
| 111 | +
|
| 112 | +``` |
| 113 | + |
| 114 | +--- |
| 115 | + |
| 116 | +## 🤝 **Contributing** |
| 117 | + |
| 118 | +Contributions, issues, and feature requests are welcome! |
| 119 | +Feel free to open a **pull request**. |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +## 📜 **License** |
| 124 | + |
| 125 | +This project is licensed under the **MIT License**. |
| 126 | + |
| 127 | +--- |
| 128 | + |
| 129 | +## ✨ **Author** |
| 130 | + |
| 131 | +**ChronoMind** — Built by *Albin David C* |
| 132 | +For learning, productivity, and building clean interfaces. |
0 commit comments