Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 4.19 KB

README.md

File metadata and controls

94 lines (60 loc) · 4.19 KB

Visitors Web UI

The code base of visitors react app in this repo references https://github.com/jdob/visitors-webui.

The dependent repo which implements visitors backend service is visitors-service.

Run server in local

To run visitors-webui locally, following instructions below:

  1. Follow instructions in Run visitors-service in local to start visitors-service first. You should see message Starting development server at http://0.0.0.0:8000/ output in the comand line interface. Otherwise, you need to troubleshoot before returning here to continue.

  2. Export environment variables required by visitors-webui:

    export REACT_APP_BACKEND_HOST=localhost
export REACT_APP_BACKEND_PORT=8000
export REACT_APP_TITLE="Custom Dashboard Title"

  3. Install nvm, node.js, and npm by following instructions in this guide. Once it's done, return here to continue.

    Note Recommend to install the stable LTS version of Node.js, install the latest version is optional.

  4. Change directory to visitors-webui, then run the following commands to start server:

    cd my-app && npm install && npm run build
cd ../api && npm install
node server.js

    You will see the following message in the output, which indicates the server is successfully started:

    [HPM] Proxy created: /  -> http://localhost:8000
[HPM] Proxy rewrite rule created: "^/api" ~> ""
Server listening on the port::3000

  5. Open http://localhost:3000/ in your browser to visit the app. You should see Custom Dashboard Title displayed in the web page. Refreshing the page and you will see one entry with 127.0.1.1 as Service IP and Client IP added to the table.

Stop server

Follow steps below to stop both frontend and backend server.

  1. Press CONTROL-C to quit the visitors-webui server.

  2. Follow instructions in Stop visitors-service server to stop backend server.

Run server in Docker

Containerize the application so that it can run as a contanier in Docker or Kubernetes cluster.

Build application image

Change directory to visitors-webui, then run the following commands to build a Docker image and push to DockerHub:

docker build -t visitors-webui:1.0.0 .
docker tag visitors-webui:1.0.0 <DockerHub-account>/visitors-webui:1.0.0
docker push <DockerHub-account>/visitors-webui:1.0.0

Run as container

As visitors-webui depends on visitors-service, you need to start visitors-service container first. Follow Run visitors-service server in Docker and return here to continue.

Then execute the command below to run the containerzed visitors-webui application in Docker.

docker run -it --rm -p 3000:3000 -e REACT_APP_BACKEND_HOST=172.17.0.2 -e REACT_APP_BACKEND_PORT=8000 -e REACT_APP_TITLE="Custom Dashboard Title" --name visitors-webui visitors-webui:1.0.0

Open http://localhost:3000/ in your browser to visit the app. You should see Custom Dashboard Title displayed in the web page. Refreshing the page and you will see one entry with 172.17.0.2 as Service IP and 172.17.0.x as Client IP added to the table.

Stop the container

To stop running the containerzed visitors-webui application, execute the command below in a separate CLI.

docker stop visitors-webui

Then follow Stop visitors-service container to stop backend container as well.

References