OpenWES Installation Guide

Choose one of the two paths below:

1. Docker (recommended) – spin everything up in < 30 s
2. Manual install – for full control or local development

---

🐳 Docker Quick-Start (30 s)

Prerequisites

• Docker
• Docker Compose (v2.20+)

One-liner

git clone https://github.com/jingsewu/open-wes.git
cd open-wes
HOST_IP=$(hostname -I | awk '{print $1}') docker-compose up -d

Services will be available at:

Service	URL
Web UI	http://localhost
Nacos	http://localhost:8848/nacos

---

🛠️ Manual / Local Install

Prerequisites

• Java 17+ – download
• MySQL 8.0+ – download
• Nacos 2.0+ – download
• Redis 7.0+ – download
• Node.js 18+ – download

ℹ️ MySQL, Nacos, and Redis must run on the same machine.
You can use the included docker-compose.yml to install them quickly.

---

1. Clone repository

git clone https://github.com/jingsewu/open-wes.git
cd open-wes

---

2. Set up backend

2.1 Load Nacos schema

mysql -u root -p nacos_config < initdb.d/nacos_config.sql

2.2 Add host entries

Edit your hosts file:

OS	Path
Linux/macOS	/etc/hosts
Windows	C:\Windows\System32\drivers\etc\hosts

Append:

127.0.0.1 nacos.openwes.com
127.0.0.1 redis.openwes.com
127.0.0.1 mysql.openwes.com

2.3 Create application database

mysql -u root -p -e "CREATE DATABASE openwes;"

2.4 Start services

From server/server/ run (in separate terminals or via IDE):

java -jar WesApplication.jar
java -jar GatewayApplication.jar
java -jar StationApplication.jar

---

3. Set up client

3.1 Rename webpack config

mv client/build/webpack.config.example.dev.js client/build/webpack.config.dev.js

3.2 Install dependencies

cd client
npm install

3.3 Start client

npm start

Client opens at http://localhost:4001.

---

Troubleshooting

Symptom	Check
Service unreachable	All prerequisites installed and running
DNS errors	hosts file contains the three aliases
DB errors	openwes database exists and credentials are correct

Still stuck?
Open an issue in the GitHub repo.