Welcome to the Black Mesa project documentation. Here you will find a table of content with links to all of our curated docs. Please take some time to familiarize yourself with the structure of the app and the coding guidelines.
###:electric_plug: Project Setup Having issues getting the project running? This tutorial will walk you through all the necessary steps to get the project running.
###:package: Project Dependencies This document covers the Node.js dependencies used in this project with links to their respective documentations.
###:vertical_traffic_light: Branching Strategy & Development Flow Please take your time getting familiar with the Branching Strategy and Development workflow contained in this document. It will help ensure quality and speed of production.
###:floppy_disk: Naming Convention Here you will find guidelines covering naming convention for files / classes / functions and more. These will cover both HTML / SCSS / JSX.
###:straight_ruler: ES6 Style Guide To ensure consistency across all of the files in this project please familiarize yourself with the Vue Template file and the desired coding style.
###:scissors: Project Codebase Linting This project is setup to lint all of the files to ensure they adhere to the code styleguides. This document contains more information on running some of the lint tasks.
###:package: Webpack 2 Asset Pipeline This document covers the Node.js dependencies used in this project with links to their respective documentations.
###:ship: Deployment Strategy This document covers the Node.js dependencies used in this project with links to their respective documentations.
##:nut_and_bolt: Vue Documentation
For General Vue.Js documentation please visit the Official Documentation Page.
###:earth_americas: Routes Covers the basics of the vue-router setup in this project as well as route management strategies for this project.
###:memo: VueX State Management This document covers the VueX state management setup and guidelines for usage in this project.
##:art: SCSS Documentation
###:iphone: Responsive UI Management This document covers all of the Responsive management elements included in this project. These will cover the Breakpoint management system as well as the use of responsive typography throughout.
###:gem: SCSS Coding Styleguide Coding best practices and styleguide for SCSS files.
##:telephone: Axios Documentation How to use Axios.