The api-documentation is open for all, but some endpoints are secured with OAuth2 through Auth0. To get access, click the Authorize-button and log in. Then send an email to [email protected] and request access.
- Node.JS ~6.2
- npm ~3.9
- Docker (optional)
What's in the box?
- Express
- Babel (ES6)
All dependencies are defined in package.json and are managed with npm. To
initially install all dependencies and when the list dependency has changed,
run npm install.
$ npm install
Start node server with hot reloading middleware listening on port 3001.
$ npm start
To use a different api set the GDL_API_URL environment variable.
Test framework: ava with enzyme.
$ npm test
Do you tdd?
$ npm run tdd
tl;dr: Use eslint! Rules: [Airbnb Styleguide]https://github.com/airbnb/javascript.
Lint code with eslint, including eslint react plugin, eslint-plugin-import, eslint-plugin-jsx-a11y.
Beside linting with globally installed eslint, eslint can be invoked with npm:
$ npm run lint
Rules are configured in ./.eslintrc.js and extends eslint-config-airbnb. If feeling brave, try eslint --fix.
# Run with NODE_ENV=production:
$ npm run start-prod
# Docker stuff
$ ./build.sh
Please update this section if you add or remove dependencies.
Hint: Running npm ls --long --depth 0 prints a list of dependencies including a brief description.
express: Fast, unopinionated, minimalist web framework http://expressjs.com/
nodemon: Simple monitor script for use during development of a node.js app. http://nodemon.io
compression Node.js compression middleware https://github.com/expressjs/compression#readme
cors Middleware for dynamically or statically enabling CORS in express/connect applications https://github.com/expressjs/cors/
defined:
return the first argument that is !== undefined.
https://github.com/substack/defined
lodash: Lodash modular utilities. https://lodash.com/
cross-env Run commands that set environment variables across platforms https://github.com/kentcdodds/cross-env
parse5 WHATWG HTML5 specification-compliant, fast and ready for production HTML parsing/serialization toolset for Node.js https://github.com/inikulin/parse5
babel-register: babel require hook https://babeljs.io/
babel-preset-es2015: Babel preset for all ES2015 plugins. https://babeljs.io/
babel-polyfill: Polyfill for a full ES2015 environment https://babeljs.io/
babel-preset-react: Babel preset for all React plugins. https://babeljs.io/
babel-plugin-transform-object-rest-spread: Compile object rest and spread to ES5 https://babeljs.io/
babel-plugin-transform-async-to-generator Turn async functions into ES2015 generators https://github.com/babel/babel/tree/master/packages/babel-plugin-transform-async-to-generator
isomorphic-fetch: Isomorphic WHATWG Fetch API, for Node & Browserify. https://github.com/matthew-andrews/isomorphic-fetch/issues
ava Futuristic test runner 🚀 git+https://github.com/avajs/ava.git
eslint: An AST-based pattern checker for JavaScript. http://eslint.org
babel-eslint Custom parser for ESLint https://github.com/babel/babel-eslint
eslint-plugin-babel An eslint rule plugin companion to babel-eslint https://github.com/babel/eslint-plugin-babel#readme
eslint-config-airbnb: Airbnb's ESLint config, following their styleguide https://github.com/airbnb/javascript
eslint-plugin-import: Import with sanity. https://github.com/benmosher/eslint-plugin-import
eslint-plugin-jsx-a11y: A static analysis linter of jsx and their accessibility with screen readers. https://github.com/evcohen/eslint-plugin-jsx-a11y#readme
eslint-plugin-react: React specific linting rules for ESLint. https://github.com/yannickcr/eslint-plugin-react