Files
zeroone/README.md
2024-06-05 23:12:16 +02:00

32 lines
1.3 KiB
Markdown

# ZERO/ONE
Haptic Configuration Suite for [Binaris Devices](https://store.binaris.io/)
![zeroone-screenshot](https://github.com/katbinaris/zeroone/assets/34353377/7c9f576d-e142-4de2-a58f-ebb83ff6a472)
## ⚠️ Signed builds will be available soon, for now you can build and run the app locally
---
## 🚀 How to run the app from source
- 🟩 Make sure you have [Node.js](https://nodejs.org/en/) installed (v20 or later)
- 🏃 Install [pnpm](https://pnpm.io/installation) (a better alternative to npm)
- ⬇️ Clone the repository and navigate to the project directory
- 📚 Run `pnpm i` to install the dependencies
- 👨‍🔬 Run `pnpm dev` to start the app in development mode
- 🛠️ Alternatively, you can run `pnpm build:win`, `pnpm build:mac`, or `pnpm build:linux` to build the app for your platform
- 🔎 The built app will be available in the `dist` directory
We recommend using [VSCode](https://code.visualstudio.com/) with the included recommended extensions for the best development experience 💪
---
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/contains-cat-gifs.svg)](https://forthebadge.com)