Add section to the readme on current tech stack

[denesnori]

Initital proposal. Feel free to add to it. I feel this version is too brief, incomplete. Any ideas?

Current Tech Stack for this prototype

• Handlebars for client-side template building (Q&A guide).
• Materialize.css, for general site design
• jQuery for DOM manipulation.
• jQuery.matchHeight.js to set the cards to have equal height.
• GSAP Animation Library(interactive section)

Future MVP Tech Stack

• React for client-side rendering
• jQuery for DOM manipulation
• Redux for state management
• GSAP Animation Library(interactive section)
• Dexie helper client side storage of Q&A using indexDB
• Sass for writing/organising CSS
• PostCSS for additional CSS utilities
• Webpack for bundling assets
• ESlint for linting

[jbesraa]

What do you think about adding tools to test the code?

[denesnori]

That's a good point!!! We should also add somehing on our planned backend structure/tools..etc!

[njsfield]

Great point- I'd like to recommend Jest for testing React code (and testing modules on the back end in general).

For visual testing (and browser compatibility testing in general), a solid automated testing suite like selenium would provide a thorough report of how our site looks and works on multiple devices. It's a premium option, but we could gain a lot from the free 7 day trial

[njsfield]

There are also lot's of great guerrilla methods that get the job done in a quick and dirty manner, like asking if people have old devices they'd be willing to test it on ;)

[MHemsley]

Thanks for being super comprehensive :) With regards to visual testing, I think we should have a discussion with the PO's should the situation arise, and see the device types they are expecting, then review and integrate it in if we get any data showing a high amount of old device usage.

Could I just check the rationale behind using React?

[denesnori]

React can be used to render the question/answers on a single page (no url redirects).

[MHemsley]

@denesnori How would you all rate your React competency/familiarity?

[jbesraa]

Hi @MHemsley

We decided to use React for these reasons: 1) the Q&A section can be broken down into components. as every page will show question and three answers, with react we can change only the question and the answers and not refreshing the whole page every time the user change the question

2) it won't be hard to add new disorders in the future as we will use the same functionality and will have only to add the data.

3) using 'state'(probably with the help of redux) will help us know what the users focus on and what questions they are interested in.

4) React is an easy framework to test.

5) two of us are already working with React.

as to the interactive part: "The interactive portion of the site could be maintained by React rendering elements, and probably would make sense to (depending on state- certain elements can be rendered into one scene and faded into view). jQuery can be used alongside the GSAP animation library to easily query elements when building timelines" @njsfield