hint

(โ˜… 3,697)

๐Ÿ’ก A hinting engine for the web

  • .editorconfig
  • .eslintignore
  • .eslintrc.json
  • .gitattributes
  • .gitignore
  • .markdownlintrc
  • .npmrc
  • .nycrc
  • azure-pipelines.yml
  • LICENSE.txt
  • package.json
  • README.md
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/webhintio/hint

Downloads the entire project code from GitHub to your computer.

cd hint

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install hint --save-dev

Downloads and installs the libraries listed in package.json.

npm run webhint -- http://localhost:8080

Type this command into your terminal and run it.

yarn hint http://localhost:8080

Type this command into your terminal and run it.

yarn

Downloads and installs the libraries listed in package.json.

yarn build

Builds optimized production files.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation