Skip to content

Commit 76ce6b0

Browse files
committed
Merged release/1.0.0-rc1 into master
2 parents 5b1c6ac + f5e4d16 commit 76ce6b0

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
## HTTP Dev-Server with Hot-Reload for JavaScript (ES6 Modules)
1+
## JSPM Dev-Server with Hot-Reload for JavaScript (ES6 Modules)
22

3-
#### Express Server ehnanced with Chokidar WebSocket Server emitting events on file changes
3+
#### NodeJS/Express Server ehnanced with Chokidar WebSocket Server emitting events on file changes
44

55
- Npm package: https://www.npmjs.com/package/jspm-hmr
6-
- ReactJS Boilerplate using this dev-server - https://github.com/piotrwitek/react-redux-typescript-starter-kit
6+
- (React / Redux / TypeScript / JSPM) Project Starter based on this Dev-Server - https://github.com/piotrwitek/react-redux-typescript-starter-kit
77

88
---
99

10+
### Motivation
11+
When starting development in JSPM/SystemJS Ecosystem you'll find out there is no standard dev-server, that could be equivalent in features to [webpack-dev-server](https://github.com/webpack/webpack-dev-server). Although there are several projects such as jspm-server (a fork of live-server), these are not well-maintained and have missing or broken support for Hot-Reload and Live-Reload which is the main focus of this project.
12+
Adding and configuring Hot-Reload manually is often hard and require advanced knowledge that not every developer needs to master in order to simply use the tool.
13+
14+
For that reasons I have decided to create library that is providing the dev-server with hot-reload preconfigured with best-practices in mind, battle-tested in production and [open-source project](https://github.com/piotrwitek/react-redux-typescript-starter-kit) and extended with new [features](https://github.com/piotrwitek/jspm-hmr/pull/4) [requested by](https://github.com/piotrwitek/jspm-hmr/issues/8) [community](https://github.com/piotrwitek/jspm-hmr/issues/3).
15+
1016
### Features
11-
- Fast Hot-Reload - using [systemjs-hot-reloader](https://github.com/capaj/systemjs-hot-reloader)
12-
- Live-reload static files (e.g. styles (CSS/SCSS), images, fonts or HTML templates) through [SystemJS Plugins Ecosystem](https://github.com/systemjs/systemjs#plugins)
13-
- Universal Module Loading with [SystemJS](https://github.com/systemjs/systemjs)
14-
- Initialize minimal App with Babel or TypeScript transpilation workflow using CLI Wizard (including Hot-Reload configuration)
17+
- Configurable and feature-full web-server based on NodeJS/Express (built-in ssl, HTML5 history api fallback, proxy, cache, browser auto-start)
18+
- Project initialization wizard - create new or update an exisintg project with preconfigured server and client scripts with battle-tested Hot-Reload setup, using [systemjs-hot-reloader](https://github.com/capaj/systemjs-hot-reloader)
19+
- `jspm-hmr` CLI utility to run a local web-server in any folder
1520

1621
---
1722

@@ -110,7 +115,7 @@ Uses:
110115
- [systemjs-hot-reloader](https://github.com/capaj/systemjs-hot-reloader) for WebSocket Client
111116
- [chokidar-socket-emitter](https://github.com/capaj/chokidar-socket-emitter) for WebSocket Server
112117

113-
### Mandatory Peer Dependencies:
118+
Peer Dependencies:
114119
- [jspm](https://github.com/jspm/jspm-cli)
115120
- [systemjs-hot-reloader](https://github.com/capaj/systemjs-hot-reloader)
116121

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jspm-hmr",
3-
"version": "1.0.0-0",
3+
"version": "1.0.0-rc1",
44
"description": "HOT-RELOAD & DEV-SERVER for Vanilla JavaScript (ES6 Modules) - powered by SystemJS & JSPM",
55
"author": "Piotr Witek <[email protected]> (http://piotrwitek.github.io)",
66
"repository": "https://github.com/piotrwitek/jspm-hmr",

0 commit comments

Comments
 (0)