Brian Fenton
535ee2b2a7
* Turning H2s into anchors to add hand cursor and to create addressable page fragments adding ref to target individual entries adding scroll handler to make sure expanded result is in view. * combining click handler directives as per CR * changing question display to always render, then hide via CSS, vs only render when state changes. * updating pug template to include heading in each URL fragment * simplifying logic & moving to vue-bootstrap accordion since multiple open panels is not required * adding pointer cursor to FAQ headings * moving initial hash checking to data prop instead of mounted so it does not trigger oddities on on hash change (re-mount) * using new pug HTML for bootstrap collapse * removing extraneous markup * updating styling to match existing page * removing fancier than necessary markup, and attendant styles * using more standard event property
Running
For information about installing and running Habitica locally, see Setting up Habitica Locally.
Preparation Reading
-
Vue 2 (https://vuejs.org)
-
Webpack (https://webpack.github.io/) is the build system and it includes plugins for code transformation, right now we have: BabelJS for ES6 transpilation, eslint for code style, less and postcss for css compilation. The code comes from https://github.com/vuejs-templates/webpack which is a Webpack template for Vue, with some small modifications to adapt it to our use case. Docs http://vuejs-templates.github.io/webpack/
-
We're using
.vuefiles that make it possible to have HTML, JS and CSS for each component together in a single location. They're implemented as a webpack plugin and the docs can be found here http://vue-loader.vuejs.org/en/ -
SemanticUI is the UI framework http://semantic-ui.com/. So far I've only used the CSS part, it also has JS plugins but I've yet to use them. It supports theming so if it's not too difficult we'll want to customize the base theme with our own styles instead of writing CSS rules to override the original styling.
The code is in /website/client. We're using something very similar to Vuex (equivalent of React's Redux) for state management http://vuex.vuejs.org/en/index.html
The API is almost the same except that we don't use mutations but only actions because it would make it difficult to work with common code
The project is developed directly in the develop branch as long as we'll be able to avoid splitting it into a different branch.
So far most of the work has been on the template, so there's no complex logic to understand. The only thing I would suggest you to read about is Vuex for data management: it's basically a Flux implementation: there's a central store that hold the data for the entire app, and every change to the data must happen through an action, the data cannot be mutated directly.
For further resources, see Guidance for Blacksmiths, and in particular the "Website Technology Stack" section.