# CtrlPad desktop application

![GitHub stars](https://img.shields.io/github/stars/ctrlPad/firmware?style=for-the-badge&logo=github) ![GitHub issues](https://img.shields.io/github/issues/ctrlPad/firmware?style=for-the-badge&logo=github) ![Last commit](https://img.shields.io/github/last-commit/ctrlPad/firmware?style=for-the-badge&logo=github)

The desktop application is written in Typescript with [Tauri](https://tauri.app)]

A couple of demo videos showing the app/project in action can be found in the [`demo`](./demo) folder.

## Table of Content

- [Development Setup](#development-setup)
- [Contributing](#contributing)

## Development Setup

To contribute to this project, please ensure you have [devenv](https://deven.sh) installed on your system.

```
# Clone the repository
git clone https://github.com/CtrlPad/desktop.git
cd desktop

# Enter the development environment
devenv shell
```

### Available Scripts

| Command             | Description                                               |
| :------------------ | :-------------------------------------------------------- |
| `tauri:build`       | Compiles the entire application.                          |
| `tauri:dev`         | Starts the frontend development server with hot reloading |
| `tauri:info`        | Displays system/environment informations                  |
| `pnpm format`       | Format all files with Prettier                            |
| `pnpm format:check` | Check the formatting of all files with Prettier           |
| `pnpm lint`         | Lint all files with ESlint                                |

## Contributing

1. **Fork** the repository
2. **Clone** your fork: `git clone https://github.com/ctrlPad/desktop.git`
3. **Branch**: `git checkout -b feature/your-feature`
4. **Commit**: `git commit -m 'feat: add some feature'`
5. **Push**: `git push origin feature/your-feature`
6. **Open** a PR

Please follow the existing code style. Thanks!