Skip to content

Commit 4b37c8a

Browse files
Gourav DwivediGourav Dwivedi
authored andcommitted
documentation changes
1 parent 61079c8 commit 4b37c8a

File tree

2 files changed

+81
-24
lines changed

2 files changed

+81
-24
lines changed

README.md

Lines changed: 77 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# SignalR-Web-Client
1+
SignalR-Web-Client
2+
======================
23
This is a JavaScript based SignalR Web Client.
34

45
It is a debugging tool to test ASP.Net Core SignalR hubs. This is a UI based SignalR client. Using this tool, we can send the data to the SignalR hub and receive the response from the SignalR Hub. This tool is design for dotnetcore developer to make their life easier when they work with SignalR.
@@ -8,32 +9,86 @@ It is a debugging tool to test ASP.Net Core SignalR hubs. This is a UI based Sig
89
<br>
910
</p>
1011

11-
## Table of Contents
12+
*Table of Contents*
1213

13-
- [Basic Understanding of](#Basic-Understanding-of)
14-
- [Install](#install)
15-
- [Usage](#usage)
16-
- [Technologies](#technologies)
17-
- [API](#api)
18-
- [Contribute](#contribute)
19-
- [License](#license)
14+
- [SignalR-Web-Client](#signalr-web-client)
15+
- [Basic Understanding of:](#basic-understanding-of)
16+
- [Prerequsit](#prerequsit)
17+
- [How to install?](#how-to-install)
18+
- [How it works?](#how-it-works)
19+
- [Baisc View](#baisc-view)
20+
- [Server Method:](#server-method)
21+
- [Request Payload:](#request-payload)
22+
- [Data Type supports:](#data-type-supports)
23+
- [Advance View](#advance-view)
24+
- [Reporting Issues](#reporting-issues)
25+
- [How to integrate?](#how-to-integrate)
26+
- [Technologies](#technologies)
27+
- [Browser Support](#browser-support)
28+
- [License](#license)
2029

2130

22-
## Basic Understanding of:
31+
# Basic Understanding of:
2332

2433
Before using this tool, you should be know few concepts about:
2534

2635
- [What is Asp.Net Core?](https://dotnet.microsoft.com/learn/aspnet/what-is-aspnet-core)
2736
- [What is SignalR in Asp.Net Core?](https://docs.microsoft.com/en-us/aspnet/core/signalr/introduction?view=aspnetcore-3.0)
2837

29-
#Prerequsit
30-
31-
# How it works?
32-
33-
SignalR Web Client have two views:
34-
1. Basic
35-
2. Advance
36-
38+
# Prerequsit
39+
40+
- Node.Js
41+
- Npm
42+
- Git
43+
44+
# How to install?
45+
46+
Tool is available [here](https://gourav-d.github.io/SignalR-Web-Client/dist/).
47+
48+
Locally installation:
49+
50+
1. Need to clone repository. Open cmd and run the below command:
51+
```
52+
git clone https://github.com/gourav-d/SignalR-Web-Client.git
53+
```
54+
2. Once the cloning is done, go inside "SignalR-Web-Client" folder.
55+
```
56+
cd SignalR-Web-Client
57+
```
58+
3. The tool need to be run under some server. This is one of the requirement of SignalR library. So, if you already have a running server, then copy the content of "SignalR-Web-Client\dist" folder and put it on your server.<br/>
59+
If you don't have server or wants to run the tool in different server, no worry.<br/>
60+
Will tell you two approches to run this tool.
61+
1. Using http server(npm). Here, we will use the published files and run under the server.<br/>
62+
```
63+
npm install http-server -g
64+
```
65+
Then go to "SignalR-Web-Client\dist" folder, and run the below command:<br/>
66+
```
67+
http-server
68+
```
69+
It will start the http-server and host the application.
70+
```
71+
Starting up http-server, serving ./
72+
Available on:
73+
http://192.168.1.5:8080
74+
http://127.0.0.1:8080
75+
http://172.18.96.166:8080
76+
Hit CTRL-C to stop the server
77+
```
78+
79+
2. Using npm. Here, we will build the tool and then run under the server. If you wants to customize the tool, then you can you this approch.
80+
```
81+
npm install
82+
npm run dev
83+
```
84+
It will start the webpack-dev-server and host the application.
85+
```
86+
> signalr-web-client@1.0.0 dev C:\demo\SignalR-Web-Client
87+
> webpack-dev-server --content-base dist --hot --mode development
88+
89+
i 「wds」: Project is running at http://localhost:8080/
90+
i 「wds」: webpack output is served from /
91+
```
3792
3893
# How it works?
3994
@@ -88,8 +143,6 @@ It has all the functionality which basic view provides, also it has additional f
88143

89144
<img src="./src/images/2.PNG" />
90145

91-
## Browser Support
92-
Currently it supports only chrome browser.
93146

94147
### Reporting Issues
95148

@@ -110,16 +163,17 @@ Then, just open a [new clear and descriptive issue](../../issues/new).
110163

111164

112165

113-
## Technologies
166+
# Technologies
114167

115168
- Aspnet-Signalr 1.1.4
116169
- Bootstrap 4.3.1
117170
- [Mitt](https://github.com/developit/mitt)
118171
- WebComponentsJs 2.2.10
119172

173+
# Browser Support
174+
Currently it supports only chrome browser.
120175

121-
122-
## License
176+
# License
123177

124178
[MIT License](https://opensource.org/licenses/MIT)
125179

Samples/AspDotCore/WebApp/WebApp/Startup.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ public void ConfigureServices(IServiceCollection services)
3535
.AllowAnyMethod()
3636
.AllowAnyHeader()
3737
.AllowCredentials()
38-
.WithOrigins("http://localhost:8080", "https://gourav-d.github.io");
38+
.WithOrigins(
39+
"http://localhost:8080",
40+
"http://127.0.0.1:8080",
41+
"https://gourav-d.github.io");
3942
}));
4043

4144
//services.AddAuthentication()

0 commit comments

Comments
 (0)