ASP.NET Core SignalR

AppVeyor:

Travis:

ASP.NET Core SignalR is a new library for ASP.NET Core developers that makes it incredibly simple to add real-time web functionality to your applications. What is "real-time web" functionality? It's the ability to have your server-side code push content to the connected clients as it happens, in real-time.

You can watch an introductory presentation here - Introducing ASP.NET Core Sockets.

This project is part of ASP.NET Core. You can find samples, documentation and getting started instructions for ASP.NET Core at the Home repo.

Packages

You can install the latest released JavaScript client from npm with the following command:

npm install @aspnet/signalr

NOTE: Previous previews of the SignalR client library for JavaScript were named @aspnet/signalr-client. This has been deprecated as of Preview 1.

The CI build publishes the latest dev version of the JavaScript client to our dev npm registry as @aspnet/signalr. You can install the module as follows:

• Create an .npmrc file with the following line: @aspnet:registry=https://dotnet.myget.org/f/aspnetcore-dev/npm/
• Run: npm install @aspnet/signalr

Alternatively, if you don't want to create the .npmrc file run the following commands:

npm install @aspnet/signalr --registry https://dotnet.myget.org/f/aspnetcore-dev/npm/

We also have a MsgPack protocol library which is installed via:

 npm install @aspnet/signalr-protocol-msgpack

Deploying

Once you've installed the NPM modules, they will be located in the node_modules/@aspnet/signalr and node_modules/@aspnet/signalr-protocol-msgpack folders. If you are building a NodeJS application or using an ECMAScript module loader/bundler (such as webpack), you can load them directly. If you are building a browser application without using a module bundler, you can find UMD-compatible bundles in the dist/browser folder; minified versions are provided as well. Simply copy these to your project as appropriate and use a build task to keep them up-to-date.

Building from source

To run a complete build on command line only, execute build.cmd or build.sh without arguments.

The build requires NodeJS (6.9 or newer) and npm to be installed on the machine.

See developer documentation for more details.