hangctt-1528 / demo-markup

⚡️ { Project name }

{ A brief description of your project... }

🛠 Installation

🔥 Setup Development

You should install Node.js stable version

NPM

$ npm i
$ npm start

Yarn

$ yarn
$ yarn start

If you don't want to development Frontend (maybe you're Backend developer), just run npm build or yarn build

HTML, CSS and JS code will be generated into /dest folder

🙏 EditorConfig

We need EditorConfig installed in your editor/IDE

✍️ Styleguides

Sass

We using Stylelint for avoid errors and enforce consistent conventions in your stylesheets.

To report your lint results:

$ npm run lint:css

To auto fixing your errors (or warning):

$ npm run lint:css:fix

About our rules config:

• Extends config of stylelint-config-standard and stylelint-config-recommended-scss.

• stylelint-order plugin for order related linting rules for stylelint.

• And override some rules from our extends

Javascript/jQuery

We using ESLint for enforce consistent conventions in your scripts.

To report your lint results:

$ npm run lint:js

To auto fixing your errors (or warning):

$ npm run lint:js:fix