Skip to content

Commit 484dec7

Browse files
committed
add read me files
1 parent 83584c2 commit 484dec7

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Get started
2+
This project contains two projects, client and server
3+
4+
## Client
5+
Client project is bootstrapped with React [read more](./client/README.md)
6+
7+
## Server
8+
Server project has udp listener and express server [read more](./server/README.md)

server/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Get started
2+
The server has two servers, UDP server and HTTP Server.
3+
4+
Before you can run the scripts, please do the following:
5+
6+
1. Create an .env file in src folder contains following data
7+
> EVENTHUB_CONNECTION_STRING="connection string to event hub" <br>
8+
> EVENTHUB_NAME="even hub name" <br>
9+
> STORAGE_CONNECTION_STRING="connection string to storage account" <br>
10+
> STORAGE_CONTAINER_NAME_EVENTHUB="storage container name to log event hub processing information" <br>
11+
2. Run command tsc to compile typescript files to js.
12+
13+
## Available Scripts
14+
In the project directory, you can run:
15+
16+
### `npm start`
17+
Runs the two servers in the development mode http://localhost.
18+
UDP Server is on port 20500
19+
Express Api Server is on port 5000
20+
21+
### `npm test`
22+
Run jest --coverage command to test all the test files.

server/tsconfig.json

+2
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,7 @@
5959
},
6060
"include": [
6161
"./src/**/*"
62+
], "exclude": [
63+
"./src/**/*.test.ts"
6264
]
6365
}

0 commit comments

Comments
 (0)