Skip to content

Commit 7a7e3ee

Browse files
committed
update readme
Signed-off-by: Jeeva Kandasamy <jkandasa@gmail.com>
1 parent ddbda40 commit 7a7e3ee

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,22 @@ This project has web console source code for the MyController server. This proje
33

44

55
## Setup development environment
6-
To setup the development environment you need to run the [backend server](https://github.com/mycontroller-org/backend) locally or somewhere else, should be accessible from your computer.<br>
6+
To setup the development environment you need to run the [MyController server](https://github.com/mycontroller-org/server) locally or somewhere else, should be accessible from your computer.<br>
77

8-
By default it looks the backend server on `http://localhost:8080` and websocket on `ws://localhost:8080`.<br>
9-
You can update the following environment variables to point your backend,
8+
By default access the MyController server on `http://localhost:8080` and websocket on `ws://localhost:8080`.<br>
9+
You can update the following environment variables to point your MyController server,
1010

11-
* `MC_PROXY_HTTP` - backend http url, default: `http://localhost:8080`
12-
* `MC_PROXY_WEBSOCKET` - backend websocket url, default `ws://localhost:8080`
11+
* `MC_PROXY_HTTP` - MyController server http url, default: `http://localhost:8080`
12+
* `MC_PROXY_WEBSOCKET` - MyController server websocket url, default `ws://localhost:8080`
1313

1414
```bash
15-
# to update the backend server details in linux
15+
# to update the MyController server details in linux
16+
# example: MyController server is running on 192.168.1.21
1617
export MC_PROXY_HTTP="http://192.168.1.21:8080"
1718
export MC_PROXY_WEBSOCKET="ws://192.168.1.21:8080"
19+
20+
# then do,
21+
yarn start
1822
```
1923

2024
## Available Scripts
@@ -33,5 +37,7 @@ It correctly bundles React in production mode and optimizes the build for the be
3337

3438
The build is minified and the filenames include the hashes.<br />
3539

40+
To see your changes on your production environment. You can copy the `build` directory and replace it with `web_console` in MyController server.
41+
3642
## Release
37-
There is no separate release for this project. The [backend repository](https://github.com/mycontroller-org/backend) takes the corresponding version(`tag`, `branch`) of this project and builds along with the backend code.
43+
There is no separate release for this project. The [server repository](https://github.com/mycontroller-org/server) takes the corresponding version(`tag`, `branch`) of this project and builds along with the backend code.

0 commit comments

Comments
 (0)