FootFall System

---

See more details at Google Drive

Installation

• Install node with npm (or yarm)
• Run npm install to add required dependencies
• To start in development mode run npm start inside the root folder (open the browser and type http://localhost:8080/)
• To bundle with production mode (to build folder), run npm start build

Guides

• React
• Redux
• Webpack
• Eslint : Airnb Style js, react
• React Components
• Redux Eco System
• Immutable.js
• Typed-Immutable
• Jest
• React Router
• API

Practises

• Make all view components (react) stateless
• Follow TDD (Test Driven Development) [Hint: npm run test:watch]
• Add dependencies correctly based on requirements (i.e. --save vs --save-dev)
• To create FSA (Flux Standard Action) compliant actions, please use {createAction} from 'redux-actions'
• In testing reducers, make sure to test unknown actions and the immutability of initial and expected objects
• We will use redux with Immutable.js (and Typed-immutable) for application store. Please follow Best Practices
• We will use 'moment.js' for all date/time related functions

Notes

• All models (including Immutable.js, Typed-immutable) are exported via 'Models' (models->index.js)

Dev Tools

• Using React Developer Tools and Redux DevTools Extension will simply development efforts and enable debugging

Versions

• Update the version.md and package.json for each release with correct version number
• Add git tag with corresponding version number

TODO

• Add support for https://github.com/react-theming/storybook-addon-material-ui
• Add test cases (specially mapping errors in API, e.g. userServiceResponseMapper)
• Add fonts (https://material-ui-next.com/style/typography/, https://material-ui-next.com/customization/themes/#typography)
• Add caching for APIs
• Add parentId = null, for displaying locations
• Add exclusion of non-working hours in graph