Radar

Realtime apps with a high level API based on engine.io

This repository contains the Radar server implementation for building real-time applications. It was originally created by Zendesk and is intended to provide a simple pub/sub interface over WebSockets (using engine.io) with tools for presence, streams, and message persistence.

中文文檔 (Traditional Chinese)

Features

• Publish/subscribe messaging model
• Presence tracking and management
• Stream subscriptions with backpressure
• Built-in rate limiting and quota support
• Client libraries available (see radar_client on npm)
• Works with Node.js >= 10

Getting Started

Prerequisites

• Node.js (version 10 or greater)
• npm or yarn

Installation

# clone the project
git clone https://github.com/Kevin28576/FRC2024.git
cd radar

# install dependencies
npm install
# or
# yarn install

Running the Server

The CLI entrypoint is bin/server.js. You can start the server with:

npm start

There are additional command‑line options described in bin/server.js.

Development

Running Tests

This project uses Mocha and Chai for unit and integration tests. Run the full test suite with:

npm test

Integration tests require a running sentinel instance; see the test folder for more details.

Linting

Source code is checked with standard:

npm run lint

Contributing

Please open an issue or pull request on the GitHub repository. The project is licensed under the Apache-2.0 license – see LICENSE for details.

License

This project is licensed under the Apache-2.0 license.