Global requirements

• Node v8.2.1

• Mongodb v3.4.6

• yarn

Installation

In main directory type:

yarn

This will install all required libraries.

Running

1. Compile: yarn run compile-front-prod

2. Create mongodb database: mkdir mongodb

3. Run mongod: mongod --dbpath ./mongodb

4. Load initial data: yarn run load-initial-data

5. Run:

• yarn run server
• with API throttling API_THROTTLE=2000 yarn run server

Development

Run: yarn run dev-server

Development mode supports hot reloading so there is no manual reloading needed.

Testing

yarn run test

Future improvements

• LRU Cache where appropriate.
• Use of Flow.js
• Server side rendering
• Frontend routing (URL for forms)
• Characters pagination
• JSDoc
• Frontend tests