iradukunda1 / Vue-Template

Vue Template Model

Template Ui

Environment Integration

The environment intergration of Template Ui constitutes a bunch of flows compelled to get started, accordingly cited below:

• Install Vue CLI for starters with yarn or npm install -g @vue/cli. (Supposedly NodeJS is already installed if not click here for further documentation or instructions on its installation.)
• Install Git latest version here. (To use git you won't need to be excellent in it but just the basic stuffs will do the job.)
• Download and Install VSCode as text editor or any other editor, but I'd recommend using it for various linting and configurations I set up to get a clear and better code style.

Getting Started

Clone the repository

• Choose any directory for the cloning.
• git clone https://github.com/iradukunda1/Vue-Vuex-Project/

Project Setup

You are supposed to go in the root directory of the project(Open the cloned project folder). Morealso open Command Prompt or any other command editor you have

Installation of Dependecies

The project dependencies are needed to get the project set up correctly.

Anyway we install them using the following command:

• yarn or npm install

Start The Project

For the server to start running the project type the following command:

• yarn or npm run dev

Code Linting

For the codes linting (If you're not familiar with javascript linting visit link)type the following command:

• yarn or npm run lint

Unit Testing

For unit tests of the project type the following command:

• yarn or npm run test:unit

Code style flow

The linter tool for the style-flow is ESlint-airbnb, and it uses prettier as code formatter. To enable VS Code + ESLint + prettier do the following the steps:

• Text editor VSCode
• In VS Code, Ctrl + Shift + X (shortcut for extensions)
• Search and install ESLint
• Search and install Prettier Code Formatter
• Restart VS Code.

Enjoy! ✌️