myems/web/README.md

6.6 KiB

myems-web

Introduction

MyEMS Web 用户界面,用于查询能源报表 Providing Web UI of MyEMS for viewing energy reports

Prerequisites

nginx-1.18.0 or later

Node.js 17.0.0 or later

Running in Local Environment for Development

sudo mkdir -p /usr/local/lib/nodejs
sudo tar -xJvf node-vxx.x.x-linux-x64.tar.xz -C /usr/local/lib/nodejs 
sudo ln -s /usr/local/lib/nodejs/node-vxx.x.x-linux-x64/bin/node /usr/bin/node
sudo ln -s /usr/local/lib/nodejs/node-vxx.x.x-linux-x64/bin/npm /usr/bin/npm
sudo ln -s /usr/local/lib/nodejs/node-vxx.x.x-linux-x64/bin/npx /usr/bin/npx

Download Latest Current Version Windows Installer (.msi) 64-bit from https://nodejs.org/en/download/current/ Install Node.js with Setup Wizard

Test installation

node -v
npm version
npx -v
  • Download all the necessary dependencies into the node_modules directory.
cd myems/web
npm i --unsafe-perm=true --allow-root --legacy-peer-deps
  • If you modified any scss files then you need to compile SCSS, else you can safely ignore this step. Run below command in your project directory to compile scss.
npm run scss
  • Starting the Development Server A local web server will start at http://localhost:3000. We are using webpack and webpack-serve to automatically detect file changes. So, if you edit and save a file, your browser will automatically refresh and preview the change.
npm start

Installation

Option 1: Install myems-web on Docker

In this section, you will install myems-web on Docker.

  • Check and change the config file if necessary:
cd myems/web
nano src/config.js
  • Replace 127.0.0.1:8000 in nginx.conf with real HOST ip and port of myems-api
cd myems/web
nano nginx.conf
  • Download all the necessary dependencies into the node_modules directory.
npm i --unsafe-perm=true --allow-root --legacy-peer-deps
  • Build for production with NPM
npm run build
  • Build a Docker image
cd myems/web
docker build -t myems/myems-web .
  • Run a Docker container
docker run -dp 80:80 --restart always --name myems-web myems/myems-web

-d Run container in background and print container ID

-p Publish a container's port(s) to the host, 8001:8001 (Host:Container) binds port 8001 (right) of the container to TCP port 8001 (left) of the host machine.

--restart Restart policy to apply when a container exits

--name Assign a name to the container

If you want to immigrate the image to another computer,

  • Export image to tarball file
docker save --output myems-web.tar myems/myems-web
  • Copy the tarball file to another computer, and then load image from tarball file
docker load --input .\myems-web.tar

Option 2: Install myems-web on Server with NGINX

nano /etc/nginx/nginx.conf

In the 'http' section, add some directives:

http{
    client_header_timeout 600;
    client_max_body_size 512M;
    gzip on;
    gzip_min_length 512;
    gzip_proxied any;
    gzip_types *;
    gzip_vary on;
    ...

}

Add a new 'server' section with direstives as below:

  server {
      listen                 80;
      server_name     myems-web;
      location / {
          root    /var/www/html/web;
          index index.html index.htm;
          # add try_files directive to avoid 404 error while refreshing pages
          try_files $uri  /index.html;
      }
      -- To avoid CORS issue, use Nginx to proxy myems-api to path /api 
      -- Add another location /api in 'server ', replace demo address http://127.0.0.1:8000/ with actual url
      location /api {
          proxy_pass http://127.0.0.1:8000/;
          proxy_connect_timeout 75;
          proxy_read_timeout 600;
          send_timeout 600;
      }
  }

Restart NGINX

sudo systemctl restart nginx
  • Install MyEMS Web UI:

Check and change the config file if necessary:

cd myems/web
sudo nano src/config.js

Build and Compress

sudo npm run build
tar czvf myems-web.tar.gz build

Install Upload the file myems-web.tar.gz to you web server. Note that the following path should be same as that was configured in nginx.conf.

tar xzf myems-web.tar.gz
sudo rm -r /var/www/html/web
sudo mv build  /var/www/html/web

Option 3: Install on Apache2 Server

  • Install Apache2 Server

refer to https://httpd.apache.org/docs/2.4/install.html

  • Configure Apache2
sudo vi /etc/apache2/ports.conf

Add a Listen

Listen 80
sudo vi /etc/apache2/sites-available/000-default.conf

Add a new 'VirtualHost' as below

<VirtualHost 127.0.0.1:80>
        ServerAdmin MyEMS-web
        DocumentRoot /var/www/web
        
        <Directory "var/www/web">
                Options FollowSymLinks
                AllowOverride All
                Require all granted
        </Directory>
        ErrorLog ${APACHE_LOG_DIR}/error.log
        CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
  • Install MyEMS Web UI:

Check and change the config file if necessary:

cd myems/web
sudo nano src/config.js

Build and Compress

cd myems/web/
sudo npm run build
tar czvf myems-web.tar.gz build

Install Upload the file myems-web.tar.gz to you web server. Note that the following path should be same as that was configured in 000-default.conf

tar xzf myems-web.tar.gz
sudo rm -r /var/www/web
sudo mv build  /var/www/web
  • avoid 404 error while refreshing pages
cd /var/www/web
sudo vi .htaccess

Add a IfModule as below:

IfModule mod_rewrite.c>
  RewriteEngine On
  RewriteBase /
  RewriteRule ^index\.html$ - [L]
  RewriteCond %{REQUEST_FILENAME} !-f
  RewriteCond %{REQUEST_FILENAME} !-d
  RewriteRule . /index.html [L]
</IfModule>

Configure rewrite.load

cd /etc/apache2/mods-enabled/
sudo vi rewrite.load

Add content as below

LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so

Option 4: Install myems-web on Node.js Web Server

  • Run below command in your project directory to make the Production build. This will create an optimized production build by compililing, merging and minifying all the source files as necessary and put them in the build/ folder.
sudo npm run build
  • Run the production build locally at http://localhost:80. If you want to listen on other port, change it in myems/web/server.js
sudo node server.js