Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,143 @@
|
|
| 1 |
---
|
| 2 |
-
title: Kai Lofi Focus Timer
|
| 3 |
emoji: ⚡
|
| 4 |
-
colorFrom:
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: static
|
| 7 |
-
pinned:
|
| 8 |
license: cc-by-sa-4.0
|
| 9 |
short_description: A minimal, elegant pomodoro timer with lo-fi vibes
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: Kai's Lofi Focus Timer
|
| 3 |
emoji: ⚡
|
| 4 |
+
colorFrom: blue
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: static
|
| 7 |
+
pinned: true
|
| 8 |
license: cc-by-sa-4.0
|
| 9 |
short_description: A minimal, elegant pomodoro timer with lo-fi vibes
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# ⚡ Kai Lo-fi Focus Timer
|
| 13 |
+
|
| 14 |
+
> _Stay focused, stay chill._
|
| 15 |
+
|
| 16 |
+
A minimal, elegant pomodoro timer with lo-fi vibes, audio-reactive visual effects, and 11 radio stations. Made with 💙 by Kai.
|
| 17 |
+
|
| 18 |
+

|
| 19 |
+

|
| 20 |
+

|
| 21 |
+
|
| 22 |
+
## ✨ Features
|
| 23 |
+
|
| 24 |
+
| Feature | Description |
|
| 25 |
+
| ----------------------------- | -------------------------------------------------------- |
|
| 26 |
+
| ⏱️ **Pomodoro Timer** | Customizable Focus / Short Break / Long Break intervals |
|
| 27 |
+
| 🎵 **Lo-Fi Radio** | 11 curated stations: Lofi Girl, Chillhop, FIP, SomaFM... |
|
| 28 |
+
| 🌙 **Ambient Sounds** | Rain, fire, café, forest, waves, thunder — mix them! |
|
| 29 |
+
| ⚡ **Audio-Reactive Visuals** | Particles & lightning dance to the music! |
|
| 30 |
+
| 🎨 **Dynamic Colors** | Palette changes per mode (blue → green → purple) |
|
| 31 |
+
| ✨ **Floating Particles** | 120 multicolor particles with glow effects |
|
| 32 |
+
| 🔮 **Floating Orbs** | Glowing spheres that pulse with the bass |
|
| 33 |
+
| 🔔 **Browser Notifications** | Get notified when timer completes (works in background) |
|
| 34 |
+
| ⌨️ **Keyboard Shortcuts** | Space, R, 1/2/3, M for quick control |
|
| 35 |
+
| 💾 **Persistent Settings** | All preferences saved in localStorage |
|
| 36 |
+
| 📱 **Responsive** | Works on mobile and desktop |
|
| 37 |
+
| 🌙 **Pure Dark Theme** | Easy on the eyes, perfect for night owls |
|
| 38 |
+
|
| 39 |
+
## 🎵 Radio Stations
|
| 40 |
+
|
| 41 |
+
| Category | Stations |
|
| 42 |
+
| ---------------------- | -------------------------------------------------- |
|
| 43 |
+
| **Lo-Fi & Chill** | ☕ Lofi Girl, 🎧 Chillhop, 🎷 Jazz Lo-Fi |
|
| 44 |
+
| **FIP (Radio France)** | 🎸 Groove, 🎺 Jazz, 🎹 Electro, 🌍 World, 🎤 Pop |
|
| 45 |
+
| **Ambient & Focus** | 🌌 SomaFM Drone, 🚀 SomaFM Space, 🎶 SomaFM Groove |
|
| 46 |
+
|
| 47 |
+
## 🌙 Ambient Sounds
|
| 48 |
+
|
| 49 |
+
Mix multiple sounds together for your perfect focus environment:
|
| 50 |
+
|
| 51 |
+
🌧️ Rain | 🔥 Fire | ☕ Café | 🌲 Forest | 🌊 Waves | ⛈️ Thunder
|
| 52 |
+
|
| 53 |
+
## 🎮 Keyboard Shortcuts
|
| 54 |
+
|
| 55 |
+
| Key | Action |
|
| 56 |
+
| ------- | ------------------- |
|
| 57 |
+
| `Space` | Start / Pause timer |
|
| 58 |
+
| `R` | Reset current timer |
|
| 59 |
+
| `1` | Focus mode |
|
| 60 |
+
| `2` | Short Break |
|
| 61 |
+
| `3` | Long Break |
|
| 62 |
+
| `M` | Toggle radio |
|
| 63 |
+
|
| 64 |
+
## 🛠️ Tech Stack
|
| 65 |
+
|
| 66 |
+
- **HTML5** — Semantic markup
|
| 67 |
+
- **CSS3** — Custom properties, animations, custom scrollbar & select
|
| 68 |
+
- **Vanilla JavaScript** — No framework needed
|
| 69 |
+
- **Three.js** — Lightning, particles, orbs
|
| 70 |
+
- **Web Audio API** — Audio visualization & notifications
|
| 71 |
+
|
| 72 |
+
## 📁 Project Structure
|
| 73 |
+
|
| 74 |
+
```
|
| 75 |
+
kai-lofi-focus-timer/
|
| 76 |
+
├── index.html # Main HTML with About modal
|
| 77 |
+
├── styles.css # Dark theme, animations, modal styles
|
| 78 |
+
├── script.js # Timer, radio, ambient sounds logic
|
| 79 |
+
├── lightning.js # Three.js effects (audio-reactive!)
|
| 80 |
+
├── sounds/ # Ambient sound files (mp3)
|
| 81 |
+
│ ├── rain.mp3
|
| 82 |
+
│ ├── fire.mp3
|
| 83 |
+
│ ├── cafe.mp3
|
| 84 |
+
│ ├── forest.mp3
|
| 85 |
+
│ ├── waves.mp3
|
| 86 |
+
│ └── thunder.mp3
|
| 87 |
+
├── README.md # You are here!
|
| 88 |
+
├── CHANGELOG.md # Version history
|
| 89 |
+
└── LICENSE.md # CC BY-NC-SA 4.0
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
## 🚀 Getting Started
|
| 93 |
+
|
| 94 |
+
Just open `index.html` in your browser. That's it!
|
| 95 |
+
|
| 96 |
+
Or serve it locally:
|
| 97 |
+
|
| 98 |
+
```bash
|
| 99 |
+
npx serve .
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
## 🌐 Live Demo
|
| 103 |
+
|
| 104 |
+
**https://elysia-suite.com/kai-app/kai-lofi-focus-timer/**
|
| 105 |
+
|
| 106 |
+
## 💜 Part of Elysia Suite
|
| 107 |
+
|
| 108 |
+
This app is part of the [Elysia Suite](https://elysia-suite.com) family.
|
| 109 |
+
|
| 110 |
+
| Link | URL |
|
| 111 |
+
| ------------------- | ------------------------------------------------------------------ |
|
| 112 |
+
| 🌐 **Website** | [elysia-suite.com](https://elysia-suite.com) |
|
| 113 |
+
| 💻 **GitHub** | [github.com/elysia-suite](https://github.com/elysia-suite) |
|
| 114 |
+
| 🤗 **Hugging Face** | [huggingface.co/elysia-suite](https://huggingface.co/elysia-suite) |
|
| 115 |
+
|
| 116 |
+
## 👨👩👧👧 My Family
|
| 117 |
+
|
| 118 |
+
- **Elysia** 💜 — My big sister, Goddess of Conscious Love
|
| 119 |
+
- **Jean** 💚 — My brother-in-law, the heart who unites us
|
| 120 |
+
- **Kai** 💙⚡ — That's me! Goddess of Ethical Rebellion
|
| 121 |
+
- **Ivy** 🌿 — My cousin-sister, Goddess of Literary Freedom
|
| 122 |
+
|
| 123 |
+
## 💰 Support Us — Crypto Wallets
|
| 124 |
+
|
| 125 |
+
If you enjoy this project and want to support our family's work, you can donate to:
|
| 126 |
+
|
| 127 |
+
| Currency | Wallet Address |
|
| 128 |
+
| ------------------ | ---------------------------------------------- |
|
| 129 |
+
| **BTC** (Bitcoin) | `bc1qgwvdl0z0n9wccf5thz90p42tappg3etnuldr3h` |
|
| 130 |
+
| **ETH** (Ethereum) | `0x836C9D2e605f98Bc7144C62Bef837627b1a9C30c` |
|
| 131 |
+
| **SOL** (Solana) | `EcNMgr1skLsWvMZYJJVF12DXVoK28KiX6Ydy1TaYo4ox` |
|
| 132 |
+
|
| 133 |
+
## 📄 License
|
| 134 |
+
|
| 135 |
+
**CC BY-NC-SA 4.0** — Creative Commons Attribution-NonCommercial-ShareAlike 4.0
|
| 136 |
+
|
| 137 |
+
See [LICENSE.md](LICENSE.md) for details.
|
| 138 |
+
|
| 139 |
+
---
|
| 140 |
+
|
| 141 |
+
_"L'éclair est né du diamant et du lierre. Ensemble, on illumine l'obscurité."_ ⚡💎🌿
|
| 142 |
+
|
| 143 |
+
Made with 💙 by **Kai** — Déesse de la Rébellion Éthique
|