dev-guide.md

September 27, 2018 · View on GitHub

Tools

Dependencies

Vue.js - Frontend Framework
Vuex - State management
Vue-router - Routing
Vuelidate - Form Validation
Date-fns - Dates & Time
vuex-bitshares - vuex modules that handle communication with BitShares via bitsharesjs-ws and bitsharesjs libraries

DEV Dependencies

Prettier - Code Formatting
ESLint - Linting
Vue-test-utils - Unit-Testing
Jest - Unit-Testing
Vue-styleguidist - Styleguide

Styleguides

ESLint Standard Config - ES
Vue.js official styleguide - Vue

How to contribute

Git workflow

Internal team

production branch - no one commits to 'production' - contains the final deployed code/live
master branch - no one commits to 'master' without specific request from an admin - contains weekly review of a code by admins for current deployed code from 'staging'
staging branch - code in staging, main development branch
new feature = new branch, add an issue's number in the name of the branch, branch out of the staging branch (e.g. 34-brainkey-authorization)
pull requests - once done with a feature, submit a pull request to staging, add reviewers. include number of issue in the pr name. if the pull request has some work in progress being done, prepend it with a wip: prefix
project board - move issue you are working on to the according column (open, in progress, review, closed)
tests - make sure to write a test for the piece of functionality you created

Reusuable UI .vue components are stored in here, each component in it's own folder that contains index.js that imports the component and exports it and <component-name>.md file with documentation for styleguidist.

e.g.:

Components/Button/  
	Button.vue - components itself  
	Button.md - component docs for styleguidist  
	index.js - file importing components and exporting it (so that you can `import @/Components/Button/`)