Use docker to run, instead of vagrant.

README.md

@@ -6,18 +6,14 @@ Basic user account management for the web.
 Example & Getting Started
 -------------------------
 
-With Vagrant installed run the following:
+With Docker installed run the following:
 
 ```
-cd vagrant
-vagrant up
-vagrant ssh
-cd src
-npm install
-node example
+./docker/docker-node npm install
+./docker/docker-run
 ```
 
-Access the site in your browser at [http://user-accounts.local:3000](http://user-accounts.local:3000).
+Access the site in your browser at [http://localhost:3000](http://localhost:3000). View email sent at `http://localhost:2525/`.
 
 A full working example with skeleton templates is provided in the `./example` folder.
 

docker/docker-node

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# This script runs a command using node:10 against the source code in docker.
+# It simplifies the development process by not containerising the entire
+# source code and provides volumes for the home directory.
+
+SCRIPT_DIR=$(dirname "$0")
+SCRIPT_DIR_PARENT=$(cd "$SCRIPT_DIR" && cd ../ && pwd)
+
+docker run -it \
+  -u $(id -u):$(id -g) \
+  -v "${SCRIPT_DIR_PARENT}:/tmp/src" \
+  -w /tmp/src \
+  node:10 \
+  "$@"

docker/docker-run

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# This script runs the server and required components.
+
+SCRIPT_DIR=$(dirname "$0")
+SCRIPT_DIR_PARENT=$(cd "$SCRIPT_DIR" && cd ../ && pwd)
+
+RUNAS="$(id -u):$(id -g)" docker-compose -f "$SCRIPT_DIR_PARENT/docker/docker-run-compose.yml" up

docker/docker-run-compose.yml

@@ -0,0 +1,21 @@
+version: '3.3'
+services:
+  email:
+    image: ksokol/mailsink
+    user: ${RUNAS}
+    ports:
+      - "2525:2525"
+  web:
+    image: node:10
+    user: ${RUNAS}
+    depends_on:
+      - email
+    ports:
+      - "3000:3000"
+    volumes:
+      - ../:/tmp/src
+    environment:
+      SMTP_HOST: email
+      SMTP_PORT: 2500
+    working_dir: /tmp/src
+    command: bash -c 'sleep 5; npm start'

example/index.js

@@ -6,6 +6,7 @@ const multer = require("multer");
 const os = require('os');
 const path = require("path");
 const ExpressUserAccounts = require("..");
+const nodemailer = require("nodemailer");
 
 const app = express();
 
@@ -25,7 +26,16 @@ const userAccounts = new ExpressUserAccounts({
     templatePath: path.join(__dirname, "user-account-templates"),
 
     // Pluggable data-stores are supported, this uses CouchDB.
-    store: new ExpressUserAccounts.PouchDbStore(path.join(os.homedir(), "users.pouchdb"))
+    store: new ExpressUserAccounts.PouchDbStore(path.join(os.homedir(), "users.pouchdb")),
+
+    // Use a custom mail transport for a mailsink for testing
+    mailTransport: nodemailer.createTransport({
+        host: process.env.SMTP_HOST || "localhost",
+        port: process.env.SMTP_PORT || 25,
+        tls: {
+            rejectUnauthorized: false
+        }
+    })
 });
 app.use(userAccounts.createMiddleware());
 app.use("/accounts", userAccounts.createUserInterface());
@@ -36,4 +46,4 @@ app.get("/", function(req, res, next) {
 });
 
 app.listen(3000);
-console.warn("Listening on port 3000");
+console.warn("Listening on port 3000");

package.json

@@ -1,7 +1,10 @@
 {
   "name": "express-user-accounts",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "private": true,
+  "scripts": {
+    "start": "node example"
+  },
   "dependencies": {
     "async": "^2.5.0",
     "base64url": "^2.0.0",