Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 1.16 KB

File metadata and controls

50 lines (41 loc) · 1.16 KB
title Development
description Preview changes locally before making a pull request
icon hammer
**Prerequisites**:
  • Node.js version 19 or higher
  • Git

Follow these steps to install and run Freedeck's bundled debug server on your operating system.

```bash git clone https://github.com/Freedeck/Freedeck.git ``` Navigate to the newly cloned Freedeck repository, then run
```bash
npm i
```
It's recommended at this point to split into two terminals: one for the Server, one for Companion. To run the debug server, simply run the package script.
```bash
npm run debug-server
```
Don't forget to run Companion. It's recommended for this to be in a separate terminal.
```bash
npm run companion
```

Code formatting

Consider Prettier or Biome for code formatting.