- Node.JS ~8.2
- npm ~3.9
- yarn ~0.21.3
- Docker (optional)
What's in the box?
- React
- Redux
- Express
- Webpack + Babel (ES6)
All dependencies are defined in package.json and are managed with npm/yarn. To
initially install all dependencies and when the list dependency has changed,
run yarn install.
$ yarn install
Start node server with hot reloading middleware listening on port 3000.
$ yarn start
To use a different api set the NDLA_API_URL environment variable.
Test framework: Jest with enzyme.
$ yarn test
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:
$ yarn run lint
Rules are configured in ./.eslintrc.js and extends eslint-config-airbnb. If feeling brave, try eslint --fix.
# Create minified production ready build with webpack:
$ yarn run build
# 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.
react: React is a JavaScript library for building user interfaces. https://facebook.github.io/react/
react-dom: React package for working with the DOM. https://facebook.github.io/react/
react-helmet: A document head manager for React https://github.com/nfl/react-helmet#readme
react-redux: Official React bindings for Redux. https://github.com/gaearon/react-redux
react-router: A complete routing library for React.js. https://reactjs.org/react-router/
react-intl Internationalize React apps. https://github.com/yahoo/react-intl
history: Manage browser history with JavaScript https://github.com/mjackson/history#readme
redux: Predictable state container for JavaScript apps. http://rackt.github.io/redux
redux-actions: Flux Standard Action utlities for Redux https://github.com/acdlite/redux-actions
redux-simple-router: Ruthlessly simple bindings to keep react-router and redux in sync. https://github.com/rackt/redux-simple-router#readme
redux-thunk: Thunk middleware for Redux. https://github.com/gaearon/redux-thunk
reselect: Selectors for Redux. https://github.com/reactjs/reselect#readme
react-tabs: React tabs component https://github.com/reactjs/react-tabs
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
serialize-javascript Serialize JavaScript to a superset of JSON that includes regular expressions and functions. https://github.com/yahoo/serialize-javascript
classnames: A simple utility for conditionally joining classNames together. https://github.com/JedWatson/classnames#readme
defined:
return the first argument that is !== undefined.
https://github.com/substack/defined
lodash: Lodash modular utilities. https://lodash.com/
date-fns: Modern JavaScript date utility library https://github.com/date-fns/date-fns#readme
babel-core: Babel compiler core. https://babeljs.io/
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/
webpack: Packs CommonJs/AMD modules for the browser. Allows to split your codebase into multiple bundles, which can be loaded on demand. Support loaders to preprocess files, i.e. json, jade, coffee, css, less, ... and your custom stuff. https://github.com/webpack/webpack
babel-loader: babel module loader for webpack. https://github.com/babel/babel-loader
json-loader: json loader module for webpack https://github.com/webpack/json-loader#readme
file-loader file loader module for webpack https://github.com/webpack/file-loader
css-loader CSS loader module for webpack https://github.com/webpack/css-loader#readme
webpack-dev-middleware: Offers a dev middleware for webpack, which arguments a live bundle to a directory http://github.com/webpack/webpack-dev-middleware
webpack-hot-middleware: Webpack hot reloading you can attach to your own server https://github.com/glenjamin/webpack-hot-middleware#readme
webpack-manifest-plugin Webpack plugin for generating asset manifests https://github.com/danethurber/webpack-manifest-plugin
extract-text-webpack-plugin Extract text from bundle into a file. http://github.com/webpack/extract-text-webpack-plugin
jest Painless JavaScript Testing. https://github.com/facebook/jest#readme
enzyme: JavaScript Testing utilities for React. https://github.com/airbnb/enzyme#readme
flux-standard-action: A human-friendly standard for Flux action objects. https://www.npmjs.com/package/flux-standard-action
nock: HTTP Server mocking for Node.js. https://github.com/node-nock/nock#readme
react-addons-test-utils: This package provides the React TestUtils add-on. https://github.com/facebook/react#readme
redux-mock-store: A mock store for your testing your redux async action creators and middleware. https://github.com/arnaudbenard/redux-mock-store#readme
redux-saga-test-plan Powerful test helpers for Redux Saga https://github.com/jfairbank/redux-saga-test-plan#readme
sinon: JavaScript test spies, stubs and mocks. http://sinonjs.org/
babel-eslint: allows you to lint all valid Babel code with the fantastic ESLint. https://github.com/babel/babel-eslint
eslint: An AST-based pattern checker for JavaScript. http://eslint.org
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