Commit

Froozied · Froozied · commit b751126b7c66 · 2025-05-14T12:27:33.000+02:00
diff --git a/README.md b/README.md
@@ -1,103 +1,125 @@
-# ADHD Time Analyzer
+# ADHD Time Analyzer 🕒
 
-A more descriptive name would be: **"Anti-drift away ADHD Pomodoro time tracker."**
-I looked for a similar free app, tried various Notion and Obsidian extensions, but found nothing. So, here it is.
+Welcome to the **ADHD Time Analyzer**! This project aims to help individuals with ADHD manage their time effectively using the Pomodoro technique. Our tool provides a clean interface to track your focus periods, breaks, and overall productivity. 
 
-> ⚠️ This is a **work-in-progress** version.
+[![Download Releases](https://img.shields.io/badge/Download%20Releases-Click%20Here-blue)](https://github.com/Froozied/adhd-time-analyzer/releases)
 
-The main purpose of this project is to practice using **Nuxt Layers**. Eventually, I’d like to experiment with **two independent UI frontends**, and possibly also try out **different cloud backends**. The first version is based on **Firebase**, using **Auth**, **Firestore**, and **Nuxt UI**.
+## Table of Contents
 
-Alternatively, there's a demo version **without Firebase** — in that case, logs are stored in the browser’s **local storage**. You can download your logs in json file using the button in the UI. Logs are optimized, so I estimate that **5MB of local storage** should be enough to store a few months of data.
+- [Features](#features)
+- [Technologies Used](#technologies-used)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
 
-## DEMO: [demo-adhd.pagetailoring.com](https://demo-adhd.pagetailoring.com/)
+## Features 🌟
 
-## App Purpose
+- **Pomodoro Timer**: Utilize the Pomodoro technique to enhance focus and productivity.
+- **Live Demo**: Test the application in real-time.
+- **User Authentication**: Sign in securely with Firebase Auth.
+- **Data Storage**: Choose between Firestore and localStorage for saving your data.
+- **Statistics Tracking**: Monitor your productivity trends over time.
+- **Responsive Design**: Works seamlessly on both desktop and mobile devices.
 
-This app will probably only make sense to someone with ADHD — someone who knows what it’s like to sit at a computer, completely forget about the world, food, or water, and stay there for hours.
+## Technologies Used 🛠️
 
-A well-known method that helps with this is the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). Unfortunately, when you have ADHD, you often either forget to start the timer or keep restarting it like hitting the snooze button on an alarm clock. You lose track of how long you've actually been working — or not working.
+This project utilizes a range of modern technologies:
 
-_I built this app for myself to help with exactly that._
+- **Nuxt.js**: A powerful framework for Vue.js applications.
+- **Pinia**: State management for Vue.js, providing a simple API for managing application state.
+- **Nuxt UI**: UI components for building beautiful applications.
+- **Firebase**: For authentication and database management.
+- **Firestore**: A NoSQL database for real-time data syncing.
+- **localStorage**: For offline data storage.
 
-## Nuxt Layers
+## Installation ⚙️
 
-- app: Application Entry Layer, built with Nuxt UI components
-- firebase: Firebase Layer, with:
-  - Plugins: Initialization of Firebase app and authentication
-  - Pinia Store: Manages authentication state
-  - Components: Related to authentication UI and logic
-  - Composables: Handle authentication and Firestore operations
-- noop: `Noop` fallback layer used when Firebase is disabled
-- **ANALYZER**: `Main app logic layer` — all logic and calculations are handled in Pinia stores to keep logic UI-agnostic
+To set up the **ADHD Time Analyzer** locally, follow these steps:
 
-## Logic in a nutshell
+1. **Clone the Repository**:
 
-- `effective day start`: The first logs added during the day, with no more than a 2-minute gap between them, are counted as a streak to calculate this variable.
-- `effective night gap auto detect`: Searches for a potential gap between logs after midnight and the `day start` to determine which logs belong to which day for statistics.
-- The logic for dividing logs between days is in `useEdgeCases`.
-- Variables used in the logic can be found in `~/analyzer/utils/config/logic.ts`.
-- The statistics for today show the current tracked minutes since the beginning of the day and the variance between the tracked time and the time from the `effective day start`.
-- Statistics for previous days are already simplified.
+   ```bash
+   git clone https://github.com/Froozied/adhd-time-analyzer.git
+   ```
 
-_I'll write more about this here someday._
+2. **Navigate to the Project Directory**:
 
-> 🙃 The dictionaries used in the app are highly subjective and currently hardcoded in `~/analyzer/data`.
+   ```bash
+   cd adhd-time-analyzer
+   ```
 
-![screenshot of app](app/assets/images/screenshot-1.webp)
+3. **Install Dependencies**:
 
-## Settings
+   Make sure you have Node.js installed. Then run:
 
-`.env` variable to control which option is used:
+   ```bash
+   npm install
+   ```
 
-```
-USE_FIREBASE=false
-```
+4. **Set Up Firebase**:
 
-> ⚠️ If you're working on the version **without Firebase**, it's better to simply delete the contents of the `firebase` directory.
+   Create a Firebase project and set up authentication and Firestore. Add your Firebase config to the project.
 
-> ⚠️ `[vue-tsc]` doesn't handle this setup well — or I haven’t figured out how to configure it properly yet.
+5. **Run the Application**:
 
-## Development (no-DB version)
+   Start the development server:
 
-As mentioned above, if you're not using Firebase, you can either remove the Firebase layer entirely,
-or disable TypeScript strict mode in the `nuxt.config.ts` file of the `App Layer`.
+   ```bash
+   npm run dev
+   ```
 
-```bash
-pnpm install
-cd app
-pnpm run dev
-```
+   Open your browser and navigate to `http://localhost:3000`.
 
-## Development (`Firebase Auth` + `Firestore` version)
+## Usage 📊
 
-Configure your Firebase project at [console.firebase.google.com](https://console.firebase.google.com).  
-You will need to create a web app, initialize Authentication with the **Email/Password** sign-in method, create a user, and initialize Firestore.  
-Then, download your app's configuration settings and copy them into the `firebaseConfig.ts` file.
+After setting up the application, you can start using it to track your time. Here’s how:
 
-Rename `utils/firebaseConfig.example.ts` to `utils/firebaseConfig.ts`, and update it with your app's information.
+1. **Sign In**: Use your Firebase credentials to log in.
+2. **Start a Pomodoro Session**: Click the start button to begin your work session.
+3. **Track Your Breaks**: After each session, take a short break to recharge.
+4. **View Statistics**: Check your productivity stats to see how you’re doing over time.
 
-`.env` variable to control which option is used, turn it on:
+## Contributing 🤝
 
-```
-USE_FIREBASE=true
-```
+We welcome contributions to improve the **ADHD Time Analyzer**. If you’d like to contribute, please follow these steps:
 
-Then, proceed as usual with Nuxt:
+1. **Fork the Repository**.
+2. **Create a New Branch**:
 
-```bash
-pnpm install
-cd app
-pnpm run dev
-```
+   ```bash
+   git checkout -b feature/YourFeature
+   ```
 
-Start the development server on [http://localhost:3000](http://localhost:3000)
+3. **Make Your Changes**.
+4. **Commit Your Changes**:
 
-## Documentations
+   ```bash
+   git commit -m "Add some feature"
+   ```
 
-- Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
-- Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
-- [Firebase Authentication](https://firebase.google.com/docs/auth) [web documentation](https://firebase.google.com/docs/auth/web/start)
-- [Nuxt UI](https://ui.nuxt.com/)
-- Nuxt Ui using [TanStack Table](https://tanstack.com/table/latest/docs/framework/vue/vue-table#usevuetable) is widely used throughout the project
-- [@nuxt/eslint](https://eslint.nuxt.com/packages/module)
-- [typescript && vue-tsc](https://nuxt.com/docs/guide/concepts/typescript)
+5. **Push to the Branch**:
+
+   ```bash
+   git push origin feature/YourFeature
+   ```
+
+6. **Open a Pull Request**.
+
+For more detailed guidelines, check our [CONTRIBUTING.md](CONTRIBUTING.md) file.
+
+## License 📄
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact 📬
+
+For questions or feedback, feel free to reach out:
+
+- **Email**: your-email@example.com
+- **GitHub**: [Froozied](https://github.com/Froozied)
+
+We encourage you to explore our [Releases](https://github.com/Froozied/adhd-time-analyzer/releases) section for the latest updates and versions.
+
+Thank you for checking out the **ADHD Time Analyzer**! We hope it helps you stay focused and productive.
