developerEhsan · developerEhsan · Feb 21, 2025 · Feb 21, 2025 · Feb 21, 2025 · Feb 21, 2025
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -27,7 +27,7 @@ if ! echo "$commit_header" | grep -E "$header_pattern" > /dev/null 2>&1; then
 
 👉 Please follow the conventional commit format and try again.
 EOF
-    exit 1
+
 fi
 
 # Count the number of lines in the commit message
@@ -36,7 +36,7 @@ line_count=$(echo "$commit_message" | wc -l)
 # Check if message has at least 3 lines (header, blank line, and description)
 if [ "$line_count" -lt 3 ]; then
     cat <<EOF
-❌ Commit description is missing!
+⚠ Commit description is missing!
 
 Your commit message must include:
 🔹 Header line (type(scope): subject)
@@ -53,7 +53,7 @@ handling token validation and improving error messages.
 
 👉 Please add a meaningful description and try again.
 EOF
-    exit 1
+
 fi
 
 # Get the second line (should be blank)
@@ -65,7 +65,7 @@ description=$(echo "$commit_message" | sed -n '3,$p')
 # Check if second line is blank and description is not empty
 if [ -n "$second_line" ] || [ -z "$description" ] || [ "${#description}" -lt 10 ]; then
     cat <<EOF
-❌ Invalid commit message format!
+⚠ Invalid commit message format!
 
 Your commit message must follow this format:
 🔹 First line: type(scope): subject
@@ -79,7 +79,7 @@ $commit_message
 
 👉 Please format your commit message correctly and try again.
 EOF
-    exit 1
+
 fi
 
 pnpm commit-msg
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,114 @@
+# Contributing to Treo
+
+Thank you for your interest in contributing to Treo! This project is an Electron-based Windows application built with modern web technologies. We appreciate contributions of all kinds, including bug fixes, feature implementations, documentation improvements, and performance optimizations.
+
+## Getting Started
+
+### Fork & Clone the Repository
+
+To contribute, follow these steps:
+
+1. Fork the repository by clicking the **Fork** button on the repository page.
+2. Clone your forked repository:
+   ```sh
+   git clone https://github.com/Your-Ehsan/Treo.git
+   cd Treo
+   ```
+
+### Install Dependencies
+
+We use `pnpm` as our package manager. If you haven't installed it globally yet, run:
+
+```sh
+npm install -g pnpm
+```
+
+Then install the project dependencies:
+
+```sh
+pnpm install
+```
+
+### Running the Development Server
+
+To start the development environment, run:
+
+```sh
+pnpm dev
+```
+
+## Building the Application
+
+Currently, the build process supports **Windows** only. To build the application, execute:
+
+```sh
+pnpm build:win
+```
+
+## Database Migrations
+
+If you make changes to the database schema, generate a new migration using:
+
+```sh
+pnpm db:generate
+```
+
+## Technology Stack
+
+This project is built using the following technologies:
+
+- **TypeScript** - Ensures type safety and maintainability.
+- **Electron** - Enables cross-platform desktop application development (Windows-focused).
+- **TanStack Router** - A powerful routing solution for modern applications.
+- **TanStack Query** - Efficiently manages server-state and data fetching.
+- **Zustand** - A minimalistic and flexible state management library.
+- **Drizzle ORM** - A type-safe SQL-based ORM for database management.
+- **Better-SQLite3** - A high-performance SQLite database library.
+- **shadcn/ui** - A collection of pre-styled, accessible UI components.
+
+## Contribution Guidelines
+
+To ensure a smooth contribution process, please follow these guidelines:
+
+- Adhere to the existing code style and project conventions.
+- Write clear and descriptive commit messages.
+- Include appropriate documentation for any new features or changes.
+- Add tests where applicable to maintain code quality and stability.
+- Open an issue before implementing significant changes to discuss feasibility and approach.
+- Ensure compatibility with the existing codebase before submitting changes.
+
+## Pull Request Process
+
+1. Create a feature branch from `main`:
+   ```sh
+   git checkout -b feature/your-feature-name
+   ```
+2. Implement your changes and commit them:
+   ```sh
+   git commit -m "feat: add feature-name"
+   ```
+3. Push your changes to your fork:
+   ```sh
+   git push origin feature/your-feature-name
+   ```
+4. Open a **Pull Request (PR)** against the `main` branch of the original repository.
+5. Mention the correct issue number in the PR description to help maintainers track changes easily.
+6. Include a **recording or screenshot** demonstrating the feature or bug fix in action, if applicable.
+7. Address any feedback or requested changes from maintainers promptly.
+
+## Code of Conduct
+
+Please follow our [Code of Conduct](https://www.contributor-covenant.org/) to maintain a professional and inclusive environment.
+
+## Additional Contribution Guidelines
+
+- **Bug Reports**: If you encounter a bug, open an issue with a clear description and steps to reproduce.
+- **Feature Requests**: Suggest improvements or new features via an issue.
+- **Security Issues**: Report vulnerabilities privately to maintainers before disclosure.
+- **Documentation Updates**: Improve clarity and completeness by updating existing documentation.
+
+## Need Help?
+
+If you have any questions, feel free to open an issue or start a discussion. We appreciate your contributions and look forward to collaborating with you!
+
+Happy coding! 🚀
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 EHSAN.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -41,8 +41,8 @@ npm install -g pnpm
 1️⃣ **Clone the Repository:**
 
 ```sh
-git clone <repository_url>
-cd <project_folder>
+git clone https://github.com/Your-Ehsan/Treo.git
+cd Treo
 ```
 
 2️⃣ **Install Dependencies:**
@@ -77,15 +77,13 @@ pnpm build:win
 
 ## 🤝 **Contributing**
 
-This project is **not open-source yet**, but it will be soon.
-
-📢 **Want to contribute or explore the codebase?** Feel free to **DM me**, and I’d be happy to provide early access.
+For more contribution guidelines see [CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ---
 
 ## 🔗 **Stay Connected**
 
-📌 **LinkedIn:** [your-ehsan](https://www.linkedin.com/in/your-ehsan/)
+[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/your-ehsan/)
 
 Looking forward to your thoughts, feedback, and contributions! 🚀
 

diff --git a/package.json b/package.json
@@ -54,8 +54,8 @@
     "@radix-ui/react-toggle": "^1.1.2",
     "@radix-ui/react-toggle-group": "^1.1.2",
     "@radix-ui/react-tooltip": "^1.1.7",
-    "@tanstack/react-query": "^5.66.6",
-    "@tanstack/react-router": "^1.106.0",
+    "@tanstack/react-query": "^5.66.8",
+    "@tanstack/react-router": "^1.109.2",
     "@tiptap/extension-code-block-lowlight": "^2.11.5",
     "@tiptap/extension-color": "^2.11.5",
     "@tiptap/extension-heading": "^2.11.5",
@@ -80,7 +80,7 @@
     "lucide-react": "^0.475.0",
     "react-day-picker": "9.5.1",
     "react-hook-form": "^7.54.2",
-    "react-medium-image-zoom": "^5.2.13",
+    "react-medium-image-zoom": "^5.2.14",
     "react-resizable-panels": "^2.1.7",
     "tailwind-merge": "^3.0.1",
     "tailwindcss-animate": "^1.0.7",