Contributing to Blink Eye

Contributions are welcome! Whether you want to report a bug, suggest an improvement, or contribute code, we appreciate your help in making Blink Eye even better.

How to Contribute

If you would like to contribute to Blink Eye, please follow these steps:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.

Thank You!

Thank you for your interest in contributing to Blink Eye! Your contributions help make Blink Eye a more effective and efficient tool for promoting eye health.

Contribution Guide

Contributions are welcome! Feel free to open issues or submit pull requests.

Contributions for improving the dashboard, enhancing customizability, and adding new languages for multilingual support are particularly appreciated.

How to Contribute:

1. Fork the repository to your GitHub account.

2. Clone the repository to your local machine:

   git clone https://github.com/your-username/blink-eye.git
   

3. Create a new branch for your changes:

   git checkout -b my-branch
   

4. Make changes to the code.

5. Commit your changes:

   git commit -m "commit message"
   

6. Push your changes to the remote repository:

   git push origin my-branch
   

7. Create a pull request on GitHub.

Application Setup

Prerequisites

1. Tauri (for building the desktop app)
2. Rust (for building the desktop app)
3. Cargo (for package management)
4. Bun (for package management)

To build and run Blink Eye (Desktop App):

1. Install JavaScript dependencies:

   bun install
   

2. Change Directory:

   cd src-tauri
   

3. Install all Cargo dependencies:

   cargo install
   

4. Change Directory:

   cd ..
   

5. Run the app in development mode:

   bun run tauri dev
   

Website Setup

Prerequisites

3. Node JS (for package management)
4. Bun (for package management)

To build and run Blink Eye (Desktop App):

1. Change Directory:

   cd website
   

2. Install dependencies:

   bun install
   

3. Run the website in development mode:

   bun run dev
   

Contributing to the Website

If anyone wants to contribute to the website, go to the /website directory.

Technologies Used in this website

• Radix
• Tailwind
• Lucide icons
• Dark mode ready
• Storybook
• Biome
• Husky + lint-staged
• shadcn/ui components

Class Merging

The cn util handles conditional classes and class merging.

Input

cn("px-2 bg-neutral-100 py-2 bg-neutral-200");
// Outputs `p-2 bg-neutral-200`