Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 2.69 KB

README.md

File metadata and controls

24 lines (20 loc) · 2.69 KB

Clubhouse Dungeons

By Quaranteam-8

Codacy Badge Codacy Badge Maintainability Test Coverage Base Pipeline

Getting setup

  1. First clone this repository by entering git clone https://github.com/cse112-sp20/Quaranteam-8.git into terminal
  2. If you don't have node installed on your computer, install it from https://nodejs.org/en/download/.
  3. Once you have node installed, go to the root of the repository and run npm install

Basic Commands

Command Description
npm run build Builds the chrome extension using the files in the src/ directory and outputs the files into dist/ directory
npm run lint Runs Eslint on all js files in the src/ and test/ directories
npm run test Runs Jest on all unit test files in the test/unit directory
npm run test:puppeteer Runs Jest on all puppeteer test files in the test/puppeteer directory
npm run docs:build Generates documentation from jsdoc comments and outputs them into the docs/ directory
npm run all Runs all commands above
npm run clean Deletes the dist/ and coverage/ directories if they are found

For More Info Checkout Our Wiki