YIWANG3 / esn-test

FSE SB2 ESN Project

About

• A Single Page Application based on hash
• Vanilla JS(No Vue, Angular, React, JQuery)

Documents

• Architecture Haiku
• OOA/UML Diagram
• Rest API
• Quality Report

How to run the project

Install all packages

npm install

Start express server

npm run watch

Start front-end resource server (support hot module reload)

npm start

Build front-end resource to deploy (no need when develop)

npm run build

Open localhost:3000 in browser

Code Structure

.
├── README.md
├── dist
│   ├── app.js
│   └── index.html
├── index.html              Main Page
├── package-lock.json
├── package.json
├── server                  Express Server
│   └── index.js
├── src                     All Front-end Resource
│   ├── index.js            Front-end main 
│   ├── index.less          All Style
│   ├── js                  js functions
│   │   ├── serverInfo.js
│   │   ├── initRouter.js
│   │   └── register.js
│   └── view                Different Pages
│       ├── about.html
│       ├── chatList.html
│       ├── error.html
│       ├── login.html
│       └── register.html
├── webpack-dev-server.js   Webpack dev server config
└── webpack.config.js       Webpack config

Notes

1. Keep *.html pure, do not bind eventListener in *.html or add stylesheet, the webpack loader do not support this, please refer to js/register.js to see how to bind eventListener
2. You can use Less (http://lesscss.org/) to write stylesheet:
3. We use Navigo (https://github.com/krasimir/navigo#readme) as our router library, if you want to add a new page, please see examples in index.js
4. You can use import and require in front-end, in node server side, you can only use require.
5. If you want to learn more about webpack, you can read the guides (https://webpack.js.org/guides/)