# @xo-cash/coordinator-server

Coordinator Server

> ⚠️ This project is in **early development phase**. Use it only if you understand what you are doing and accept the risks. **Do not use funds you are not willing to lose.** Minor version bumps may introduce **breaking changes**

## Installation

```bash
npm install @xo-cash/coordinator-server
```

## Scripts

| Command                            | Description                                  |
| ---------------------------------- | -------------------------------------------- |
| `npm run build`                    | Compile TypeScript to `dist/`                |
| `npm run test`                     | Run tests with coverage                      |
| `npm run style`                    | Lint with ESLint (read-only)                 |
| `npm run syntax`                   | Type-check without emitting (`tsc --noEmit`) |
| `npm run format`                   | Auto-fix formatting and linting              |
| `npm run docs`                     | Generate TypeDoc API docs to `public/`       |
| `npm run spellcheck`               | Spell-check source and test files            |
| `npm audit --audit-level=moderate` | Performs npm audit                           |

## Links

- [Repository](https://gitlab.com/GeneralProtocols/xo/coordinator-server)
- [Issues](https://gitlab.com/GeneralProtocols/xo/coordinator-server/-/work_items)

## License

[MIT](LICENSE)