gigya / node-gigya-boilerplate Goto Github PK

Boilerplate Node.js App using the Gigya accountJS Raas service

JavaScript 64.86% Gherkin 15.84% HTML 19.30%

babel mocha chimp gigya-client gigya nodemon e2e-tests cucumberjs gherkin

node-gigya-boilerplate's Introduction

Node Gigya Boilerplate

Boilerplate Node.js App using the Gigya accountJS Raas service. This project is intended to be used as a starting point for anyone working with the gigya platform on node.js

Support: raise an issue on github https://github.com/maxmckenzie/node-gigya-boilerplate/issues

Features

babel es2015 and stage-0
mocha unit tests
webdriverio integration e2e tests using chimp
direnv directory based environment variables (so you do not need to install global node modules)
Travis CI support
Express server
ejs templating

Install Dependencies

The blow steps are for OSX, but you could replace brew with yum or apt-get and it should still work.

Windows user: your on your own with how to install but you still need the below installed. Also be aware that some of the commands in the packages.json may not work on a windows box. Linux or OSX is suggested for this Boilerplate.

You should use node v6.10.1 Long term support or cucumber will not report errors correctly

brew install node
brew install direnv

Install App

npm install
direnv allow

Run Dev

npm run dev

This boots the app runs the unit and e2e tests. Then uses nodemon to wait for changes. When a change happens the node server is rebooted and the tests are run again

mocha --watch and similar has an issue. To run the server on test you need to add an import to the test.js file. When watching this cause a EDDRINUSE error (the server is already booted). running the stack with nodemon avoids this

Production

npm run build
npm start

ToDo

.github/ template files
Gigya intergration

node-gigya-boilerplate's People

Contributors

Stargazers

Watchers

Forkers

geekvikas

node-gigya-boilerplate's Issues

[rl-reuse_tool-4] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

views do not exist on prod build

Error: Failed to lookup view "pages/index" in views directory "/Users/maxmckenzie/Development/gigya/node-gigya-boilerplate/dist/views"

due to the organisation of the view directory inside of the src folder npm run build and npm start does not pick up the templates. This could be solved by moving it to root. But i don't really want to do that.

I would prefer that it stayed there, used es6 along with the assets directory then using something like webpack to built it all out to the dist folder.