An open API service indexing awesome lists of open source software.

https://github.com/mycontroller-org/web-console

MyController 2.x Web Console
https://github.com/mycontroller-org/web-console

Last synced: 2 months ago
JSON representation

MyController 2.x Web Console

Awesome Lists containing this project

README

          

# MyController v2.x Web Console
This project has web console source code for the MyController server. This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Setup development environment
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.

By default access the MyController server on `http://localhost:8080` and websocket on `ws://localhost:8080`.

You can update the following environment variables to point your MyController server,

* `MC_PROXY_HTTP` - MyController server http url, default: `http://localhost:8080`
* `MC_PROXY_WEBSOCKET` - MyController server websocket url, default `ws://localhost:8080`

```bash
# to update the MyController server details in linux
# example: MyController server is running on 192.168.1.21
export MC_PROXY_HTTP="http://192.168.1.21:8080"
export MC_PROXY_WEBSOCKET="ws://192.168.1.21:8080"

# then do,
yarn start
```

## Available Scripts
In the project directory, you can run:

### `yarn start`
Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

### `yarn build`
Builds the app for production to the `build` folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

To see your changes on your production environment. You can copy the `build` directory and replace it with `web_console` in MyController server.

## Release
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.