v1.0.0

Author: jkyberneees

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "10"
+
+install: npm install

Dockerfile

@@ -0,0 +1,16 @@
+FROM node:12-alpine 
+
+RUN mkdir /restana-static
+WORKDIR /restana-static
+
+COPY package.json .
+COPY package-lock.json .
+COPY index.js .
+COPY server.js .
+COPY config ./config
+COPY dist ./dist
+
+RUN npm install --production
+
+CMD ["node", "index.js"]
+

README.md

@@ -1,2 +1,32 @@
 # restana-static
- Efficiently serve static files using Node.js and Docker containers.
+Efficiently serve static files using Node.js and Docker containers: https://itnext.io/restana-static-serving-the-frontend-with-node-js-beyond-nginx-e45fdb2e49cb
+
+## Configuration options
+restana-static image configuration is manage using the module: https://www.npmjs.com/package/config, so developers can manage multiple envirments if desired.  
+
+The `/restana-static/config` directory should be populated/overwritten during image creation. 
+
+### Default configuration: 
+```json
+{
+    "port": 3000,
+    "cacheEnabled": true, 
+    "cacheControlHeaderValue": "public, no-cache, max-age=604800",
+    "distDirectory": "dist/",
+    "defaultFile": "index.html",
+    "logsFormat": "tiny"
+}
+```
+> File location : `/restana-static/config/default.json`
+
+## Adding static files
+The `/restana-static/dist` directory should be populated/overwritten during image creation. 
+> Please consider that default path will change if you overwrite the `distDirectory` config.
+
+## Log formats
+Logs are provided by the module: https://www.npmjs.com/package/morgan  
+
+Allowed `logsFormat` values are described at: https://www.npmjs.com/package/morgan#predefined-formats
+
+## Cache support
+Caching is provided by the module: https://www.npmjs.com/package/http-cache-middleware

config/default.json

@@ -0,0 +1,8 @@
+{
+    "port": 3000,
+    "cacheEnabled": true, 
+    "cacheControlHeaderValue": "public, no-cache, max-age=604800",
+    "distDirectory": "dist/",
+    "defaultFile": "index.html",
+    "logsFormat": "tiny"
+}

index.js

@@ -0,0 +1,3 @@
+const { server, port } = require('./server')()
+
+server.start(port)