Files
ESP3D-WEBUI/README.md
2020-09-08 17:06:03 +02:00

54 lines
1.4 KiB
Markdown

# ESP3D-WEBUI 3.0
using Preact per @aganov suggestion
## In alpha stage - ready to test...
[Latest development version ![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic)](https://github.com/luc-github/ESP3D-WEBUI/tree/3.0) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/luc-github/ESP3D-WEBUI/3.0?style=plastic) ![Travis (.org) branch](https://img.shields.io/travis/luc-github/ESP3D-WEBUI/3.0?style=plastic)
### Setup development tools
1 - Install current nodejs LTS (currently using v12.18.3)
```
node -v
v12.18.3
npm -v
6.14.6
```
2 - Download all necessary packages in ESP3D-WEBUI directory (repository root)
```
npm install
```
### Start dev server
in ESP3D-WEBUI directory (repository root)
```
npm run dev
```
will open http://localhost:3000
Back end query server is localhost:8080, websocket server is localhost:81
### Build index.html.gz to /dist folder
in ESP3D-WEBUI directory (repository root)
```
npm run build
```
### Code beautify with prettier
use pluggin or cli
```
npm install --global prettier
```
the config file is .prettierrc
a batch is available if you need : prettyfiles.bat, it is just automating the following commands:
prettier --config .prettierrc --write "{src/**/,webpack/**/}*.js"
prettier --config .prettierrc --write src/**/*.html"
# Chat
ESP3D is now on discord https://discord.gg/h2pkaf