adds boilerplate

foresterjs · Jan 9, 2016 · 8354aa5 · 8354aa5
1 parent 5e7d514
commit 8354aa5
Show file tree

Hide file tree

Showing 10 changed files with 139 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 .*
 !.gitignore
 node_modules
+npm-debug.log
+/config/*.json
diff --git a/README.md b/README.md
@@ -1 +1,15 @@
-# forester-boilerplate
+# forester-boilerplate
+
+## Getting started
+
+1. Install dependencies ` $ npm install `
+2. Copy `config/auth.json.dist` to `config/auth.json` and configure this file
+3. Copy `config/db1.json.dist` to `config/db1.json` and configure this file
+4. Start project `$ npm start`
+5. Open `http://localhost:3000`
+
+## Contributing
+Your contributions (issues and pull request) are appreciated!
+
+### License
+MIT
diff --git a/config/auth.json.dist b/config/auth.json.dist
@@ -0,0 +1,5 @@
+{
+  "jwt": {
+    "secret": "change_me"
+  }
+}
diff --git a/config/db1.json.dist b/config/db1.json.dist
@@ -0,0 +1,7 @@
+{
+  "name": "db1",
+  "adapter": "mongo",
+  "options": {
+    "connectionUri": "mongodb://localhost:27017/forester"
+  }
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "forester-boilerplate",
+  "version": "0.0.0",
+  "description": "A boilerplate project based on forester",
+  "scripts": {
+    "start": "node src/server.js"
+  },
+  "dependencies": {
+    "forester": "^0.4.0",
+    "forester-auth": "^0.1.4",
+    "forester-explorer": "^0.1.4"
+  }
+}
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Forester Boilerplate</title>
+</head>
+<body>
+Hello! This is a Forester boilerplate project!
+</body>
+</html>
diff --git a/src/sample-plugin.js b/src/sample-plugin.js
@@ -0,0 +1,10 @@
+"use strict";
+
+module.exports = function (config) {
+
+  return function (forester) {
+    //do something with forester
+    console.log("sample plugin started");
+  };
+
+};
diff --git a/src/server.js b/src/server.js
@@ -0,0 +1,43 @@
+"use strict";
+
+// libraries
+const path = require('path');
+const Forester = require('forester');
+const foresterExplorer = require("forester-explorer");
+const foresterAuth = require("forester-auth");
+const samplePlugin = require("../src/sample-plugin.js");
+
+//project items
+const collections = [
+  require('../structure/articles.json')
+];
+const dataSources = [
+  require('../config/db1.json')
+];
+const mappings = require('../structure/mappings.json');
+const authConfig = require('../config/auth.json');
+
+//init forester
+var app = new Forester();
+
+//add plugins
+app.use(foresterExplorer());
+app.use(foresterAuth(authConfig));
+app.use(samplePlugin());
+
+//register project items
+app.registerCollections(collections);
+app.registerDataSources(dataSources);
+app.registerMappings(mappings);
+
+//register project public folder
+app.registerStaticRoute({route: '/', failback: "index.html", path: path.join(__dirname, '../public')});
+
+//boot
+app.boot()
+  .then(function () {
+    app.listen({port: 3000});
+  })
+  .catch(function (e) {
+    console.log(e.stack);
+  });
diff --git a/structure/articles.json b/structure/articles.json
@@ -0,0 +1,20 @@
+{
+  "name": "articles",
+  "properties": {
+    "title": {
+      "type": "string",
+      "required": true
+    },
+    "description":{
+      "type": "string",
+      "default": "default description",
+      "required": true
+    }
+  },
+  "defender": [
+    {
+      "action": "*",
+      "check": "skip"
+    }
+  ]
+}
diff --git a/structure/mappings.json b/structure/mappings.json
@@ -0,0 +1,14 @@
+[
+  {
+    "collection": "articles",
+    "datasource": "db1"
+  },
+  {
+    "collection": "_users",
+    "datasource": "db1"
+  },
+  {
+    "collection": "_tokens",
+    "datasource": "db1"
+  }
+]