/bq-global

Dish Washing E-commerce Website

Primary LanguageVue

BQ-GLOBAL

About the project

Premium quality liquid dish wash Your Kitchen cleaning expert

Tech Stack

Client: VueJS, Vuex

Server: Golang

Tools and Cheatsheet

Before running the project locally, make sure the following have been installed:

  • Node
  • NPM
  • Vue 3

Libraries and packages used:

Useful Links:

Building the app locally

Clone the project

  git clone https://github.com/bq-global.git

Go to the project directory

  cd bg-global

Install dependencies

  npm install

Start the server

  npm run serve

Code Standards

  • Folder names should be in camelCase e.g components, getStarted, auth
  • Vue files should be in PascalCase e.g Home.vue, TheFooter.vue, BaseInput.vue
  • Make sure to run npm run lint before pushing any code.
  • Never use v-if on the same element as v-for

VueJS Style

All code must meet the Style Guide. This makes certain that all code is the same format as the existing code and means it will be as readable as possible. Any code written otherwise will not be approved.

Pull Request Checklist

When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:

  • It passes tests: run the following command to run all of the tests locally:

    npm run lint
    
  • Impacted code has new or updated tests

  • Documentation created/updated

  • Follows all the code standards required.