You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@senssoft.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/01/26 18:02:00 UTC
[jira] [Commented] (SENSSOFT-250) Create README for UserALE.js
examples directory
[ https://issues.apache.org/jira/browse/SENSSOFT-250?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16341366#comment-16341366 ]
ASF GitHub Bot commented on SENSSOFT-250:
-----------------------------------------
Github user rgfoley commented on a diff in the pull request:
https://github.com/apache/incubator-senssoft-useralejs/pull/4#discussion_r164179927
--- Diff: example/README.md ---
@@ -0,0 +1,68 @@
+# UserALE.js Example
+
+This directory provides
+ * example usage for UserALE.js within a simple HTML Webpage,
+ * how users can expect to log UserALE events, and
+ * what log events looks like within a simple UserALE logging server.
+
+## Prerequisites
+
+Please see the [Prerequsites](https://github.com/apache/incubator-senssoft-useralejs#prerequsites)
+
+## Running the Logging Server
+
+Assuming you have [node.js](https://nodejs.org/) installed, simply run
+
+```
+node server.js
--- End diff --
Should just be `npm run example:watch`
> Create README for UserALE.js examples directory
> -----------------------------------------------
>
> Key: SENSSOFT-250
> URL: https://issues.apache.org/jira/browse/SENSSOFT-250
> Project: SensSoft
> Issue Type: Improvement
> Components: documentation, UserALE.js
> Affects Versions: UserALE.js 0.1.0
> Reporter: Lewis John McGibbney
> Assignee: Rob Foley
> Priority: Major
> Fix For: UserALE.js 0.1.0
>
> Original Estimate: 2h
> Remaining Estimate: 2h
>
> Right now, when attempting to install and use UserALE.js from source, I had the following issues
> Installation requires the following prerequisites to be installed
> {code}
> npm install gulp
> npm install del
> npm install gulp-eslint
> npm install rollup
> npm install rollup-plugin-json
> npm install gulp-uglify
> npm install gulp-rename
> npm install gulp-mocha
> npm install babel-register
> npm install express
> npm install body-parser
> {code}
> In addition, we should provide a simple README which will live in the examples directory. It basically should state the startup procedure as well as how to use the *click me* button in the index.html. Finally it should explain what type of results one would expect...
> In addition, I received the following TypeError when logging events using the example server
> {code}
> TypeError: req.body.forEach is not a function
> at /usr/local/incubator-senssoft-useralejs/example/server.js:77:12
> at Layer.handle [as handle_request] (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/layer.js:95:5)
> at next (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/route.js:137:13)
> at Route.dispatch (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/route.js:112:3)
> at Layer.handle [as handle_request] (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/layer.js:95:5)
> at /usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/index.js:281:22
> at Function.process_params (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/index.js:335:12)
> at next (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/index.js:275:10)
> at jsonParser (/usr/local/incubator-senssoft-useralejs/node_modules/body-parser/lib/types/json.js:112:7)
> at Layer.handle [as handle_request] (/usr/local/incubator-senssoft-useralejs/node_modules/express/lib/router/layer.js:95:5)
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)