Running as standalone or as module

daquinoaldo · daquinoaldo · commit 7c4ef5182af3 · 2018-08-16T11:49:09.000+02:00
diff --git a/README.md b/README.md
@@ -1,21 +1,38 @@
 # HTTPS server running on localhost
+Run an express server on localhost with HTTP2 and SSL for free.
+
+Serve static files or import as module in your project
+
 
 ### Install and trust the certificate
 Add the root certificate we just generated to your list of trusted certificates.
 This step depends on the operating system you're running:
+
 - Mac OS: open Keychain Access, choose System from the left navigation bar, choose "Import items..." from the File app
 menu and select the file. Then double-click on the certificate and select always-trust in the Trust panel.
+
 - Linux: Depending on your Linux distribution, you can use `trust`, `update-ca-certificates` or another command to mark
 the generated root certificate as trusted.
 
+
 ### Run
-1. Edit [server.js](server.js):
-    - serve static files with `app.use(express.static('<path-to-serve>'))`
-    - use express as backend, i.e.: `app.get('/', (req, res) => res.send('Hello World!'))`
-2. Install dependency with `npm install`
-3. Run with `sudo npm start` or `sudo node serve.js` (root required to use port 443)
 
-### License
-[AGPL-3.0](LICENSE)
+#### Use standalone
+From terminal navigate into the folder and run `sudo npm install -g` to install this tool globally.
 
-**Thanks to:** [Daksh Shah](https://github.com/dakshshah96)
+Then serve static file with `sudo serve <static-path>`.
+
+
+#### Use as module
+Just require this module. It will start the server automatically.
+
+For example, put in your index.js file:
+```
+const app = require('./index.js')
+app.get('/', (req, res) => res.send('Hello World!'))
+```
+
+---
+
+### License
+[AGPL-3.0](LICENSE)
diff --git a/index.js b/index.js
@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+const path = require('path')
+const fs = require('fs')
+const http = require('http')
+const https = require('spdy') // using HTTP/2: spdy will be deprecated soon, waiting for HTTP/2 on https module.
+const express = require('express')
+const compression = require('compression')
+
+// SSL certificate
+const certOptions = {
+  key: fs.readFileSync(path.resolve(__dirname + "/cert/server.key")),
+  cert: fs.readFileSync(path.resolve(__dirname + "/cert/server.crt"))
+}
+
+// run express on 443
+const app = express()
+https.createServer(certOptions, app).listen(443)
+
+// gzip compression and minify
+app.use(compression())
+app.set('json spaces', 0)
+
+// redirect http to https
+http.createServer(function (req, res) {
+  res.writeHead(301, { "Location": "https://" + req.headers['host'] + req.url })
+  res.end()
+}).listen(80)
+
+// ready
+console.info("Server running on port 443.")
+
+// serve static files, launch as: 'node index.js <static-path>'
+const staticPath = process.argv[2]
+if (staticPath) app.use(express.static(staticPath))
+
+// export as module
+module.exports = app
diff --git a/package.json b/package.json
@@ -1,11 +1,13 @@
 {
   "name": "https-localhost",
-  "version": "1.0.0",
+  "version": "0.2.0",
   "description": "HTTPS server running on localhost",
-  "main": "server.js",
+  "main": "index.js",
   "scripts": {
-    "start": "node server.js",
-    "http2": "HTTP2=true node server.js"
+    "start": "node index.js"
+  },
+  "bin": {
+    "serve": "./index.js"
   },
   "repository": {
     "type": "git",
diff --git a/server.js b/server.js
