danger-js

(★ 5,502)

⚠️ Stop saying "you forgot to …" in code review

  • .babelrc
  • .editorconfig
  • .eslintignore
  • .eslintrc.js
  • .flowconfig
  • .gitattributes
  • .gitignore
  • .npmignore
  • .pre-commit-config.yaml
  • .prettierignore
  • .release-it.json
  • appveyor.yml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • dangerfile.circle.js
  • dangerfile.flow.js
  • dangerfile.lite.ts
  • dangerfile.ts
  • Dockerfile
  • LICENSE
  • package.json
  • README.md
  • SECURITY.md
  • tsconfig.json
  • tsconfig.production.json
  • tsconfig.spec.json
  • tslint.json
  • VISION.md
  • wallaby.js
  • yarn.lock

🚀 Installation Guide

1. Get the code
git clone https://github.com/danger/danger-js

Downloads the entire project code from GitHub to your computer.

cd danger-js

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g yarn

Installs the package published on the npm registry globally — no need to clone the source.

After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t danger-js .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 danger-js

Runs the built image as an actual container.

Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
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 -g yarn

Installs the package published on the npm registry globally — no need to clone the source.

yarn install

Downloads and installs the libraries listed in package.json.

yarn test

Type this command into your terminal and run it.

yarn lint

Type this command into your terminal and run it.

yarn build; node --inspect distribution/commands/danger-pr.js https://github.com/danger/danger-js/pull/817

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