Go to file
Nate McMaster 8a7f495141
Specify NodeJS as a required toolset to build this repo (#1065)
2017-10-31 14:18:19 -07:00
.vscode
benchmarks/Microsoft.AspNetCore.SignalR.Microbenchmarks
build
client-ts Removing sending OPTIONS request if WebSocket transport requested (#1036) 2017-10-23 10:28:33 -07:00
samples
specs Adding StreamCompletion message to the HubProtocol spec (#1041) 2017-10-23 10:45:14 -07:00
src Fix parameter name (#1066) 2017-10-30 12:55:12 -07:00
test Late parameter binding (#1049) 2017-10-30 11:31:57 -07:00
.appveyor.yml
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
Directory.Build.props
Directory.Build.targets
LICENSE.txt
NuGet.config
NuGetPackageVerifier.json
README.md Specify NodeJS as a required toolset to build this repo (#1065) 2017-10-31 14:18:19 -07:00
SignalR.sln
build.cmd
build.sh
korebuild.json Specify NodeJS as a required toolset to build this repo (#1065) 2017-10-31 14:18:19 -07:00
run.cmd
run.ps1
run.sh
version.xml

README.md

ASP.NET Core SignalR

AppVeyor: AppVeyor

Travis: 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-client

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

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

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

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

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.

Before opening this project in Visual Studio or VS Code, execute build.cmd /t:Restore (Windows) or ./build.sh /t:Restore (Linux/macOS). This will execute only the part of the build script that downloads and initializes a few required build tools and packages.

See developer documentation for more details.