From a26ad990c92ae6e6862da322816dd20fbbc751b4 Mon Sep 17 00:00:00 2001
From: Jasper Dansercoer <jasper@kayzr.com>
Date: Tue, 18 Dec 2018 21:44:37 +0100
Subject: [PATCH] Initial commit

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b3e5873
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+Express & ES6 REST API Boilerplate
+==================================
+
+This is a straightforward boilerplate for building REST APIs with ES6 and Express.
+
+- ES6 support via [babel](https://babeljs.io)
+- REST resources as middleware via [resource-router-middleware](https://github.com/developit/resource-router-middleware)
+- CORS support via [cors](https://github.com/troygoode/node-cors)
+- Body Parsing via [body-parser](https://github.com/expressjs/body-parser)
+
+> Tip: If you are using [Mongoose](https://github.com/Automattic/mongoose), you can automatically expose your Models as REST resources using [restful-mongoose](https://git.io/restful-mongoose).
+
+
+
+Getting Started
+---------------
+
+```sh
+# clone it
+git clone git@github.com:developit/express-es6-rest-api.git
+cd express-es6-rest-api
+
+# Make it your own
+rm -rf .git && git init && npm init
+
+# Install dependencies
+npm install
+
+# Start development live-reload server
+PORT=8080 npm run dev
+
+# Start production server:
+PORT=8080 npm start
+```
+Docker Support
+------
+```sh
+cd express-es6-rest-api
+
+# Build your docker
+docker build -t es6/api-service .
+#            ^      ^           ^
+#          tag  tag name      Dockerfile location
+
+# run your docker
+docker run -p 8080:8080 es6/api-service
+#                 ^            ^
+#          bind the port    container tag
+#          to your host
+#          machine port   
+
+```
+
+License
+-------
+
+MIT