compress stuff

Author: thedumbterminal

.gitignore

@@ -1 +1,2 @@
-/node_modules/
+node_modules
+dist

README.md

@@ -1,5 +1,7 @@
 # Tiny Browser Framework
 
+Tiny browser web framework, which communicates to the server via a websocket. All DOM changes are performed using HTML provided by the server.
+
 ## Specification
 
 ### Client
@@ -10,14 +12,32 @@ Other clickable elements will be augmented if the `data-url` property is set. Th
 
 ### Server
 
-A server must return JSON from GET requests in the following format:
+A server must return JSON from websocket requests in the following format:
 
     [{
     	"action": "append|replace",
     	"container": "ID of container element to update",
     	"content": "HTML string"
     ]}
 
+### Demo
+
+To run the example server use:
+
+    nvm use
+    npm install
+    npm start
+
+Then open [http://localhost:3000/](http://localhost:3000/) in your browser.
+
+This is a simple todo list app, which also supports a reminder for an item.
+
+This example shows the following:
+
+* Using a cookie session with a websocket.
+* Direct DOM change from user action.
+* Indirect DOM change from user action.
+
 ## Compatibility
 
 Browser shims for modern browser functionality are not included in this project.
@@ -27,6 +47,4 @@ Browser shims for modern browser functionality are not included in this project.
 
 ## Todo
 
-* Implement more actionable elements, such as images, tick boxes or links etc.
-* Use websocket for all changes.
-* Add example for a related DOM change.
+* Implement more actionable elements, such as images or links etc.

example/server.js

@@ -6,6 +6,8 @@ const url = require('url')
 const qs = require('qs')
 const http = require('http')
 const WebSocket = require('ws')
+//const staticGzip = require('static-gzip')
+var compression = require('compression')
 
 const app = express()
 
@@ -15,6 +17,7 @@ const sessionHandler = session({
 	secret: 'really secure'
 })
 
+app.use(compression())
 app.use(sessionHandler)
 
 const server = http.createServer(app);
@@ -24,7 +27,7 @@ const wss = new WebSocket.Server({
 	path: '/websocket'
 })
 
-app.use(express.static('src'))
+app.use(express.static('dist'))
 
 app.get('/', function(req, res, next){
 	const response = `

package.json

@@ -1,12 +1,16 @@
 {
   "scripts": {
-    "exampleServer": "nodemon example/server.js"
+    "build": "mkdir -p dist && uglifyjs src/index.js -v -o dist/index.js",
+    "exampleServer": "nodemon example/server.js",
+    "start": "npm run build && npm run exampleServer"
   },
   "devDependencies": {
+    "compression": "^1.6.2",
     "express": "^4.14.1",
     "express-session": "^1.15.1",
     "nodemon": "^1.11.0",
     "qs": "^6.3.1",
+    "uglify-js": "^2.8.7",
     "ws": "^2.2.0"
   }
 }