Skip to content

3.1. Standardization

Danny Coulombe edited this page Apr 10, 2020 · 4 revisions

It is important that we conserve and work using the same stack. It prevents errors that would never have occurred if we'd would all have been using the same tools. That's why we favourize continuous integration as a deployment strategy. To make sure that what we have on our local machine, runs as expected once deployed on another machine.

Libraries

The following libraries and tools must be installed before you start working on any project:

  • NPM v6.4.1
  • Node 10.15.0
  • PHP 7.3.5
  • MySQL 8.0.16
  • Apache 2.4.39

Make sure you DOWNGRADE if any of these versions are greater on your local machine. For Windows users, Wamp offers those versions right off the bat. http://www.wampserver.com/

Paths

All projects MUST be accessible from C:\dev folder or /dev under Mac or Linux. So when you clone a repository, make sure you serve and build them from that path. This standard allows us to avoid issues related to path declaration while deployment our code on other environment.

Case Styles

Depending on the language and location of your code, the case styles might be subject to standardization. All types are used in the project. Consider the following:

  • camelCase
    • Variables
  • PascalCase
    • Component name
    • Class names
  • snake_case
    • HTML IDs
  • kebab-case
    • CSS/HTML classes
    • HTML attributes
  • UPPERCASE
    • Constants

* Make sure to prefix references with $ if placed within a variable. For instance const $button = this.$refs.button.

Templating

Make sure to follow the following standards while coding templates.

  • Add spaces in between curly brackets. For instance {{ myVar }} but never {{myVar}}.

Clone this wiki locally