Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Spectacular Test Runner for JavaScript
CoffeeScript JavaScript Shell HTML Cucumber Python Other

Merge pull request #1472 from anshbansal/patch-1

Updated example to have comment about libraries
Failed to load latest commit information.
bin feat: remove `karma` binary in favor of karma-cli
client chore: Move to standard JS style.
docs Updated example to have comment about libraries
lib Merge pull request #1461 from Dignifiedquire/fix-favicon
logo chore: add logo
scripts chore: Move to standard JS style.
static feat(runner): Use favicon in static runner pages
tasks chore: Move to standard JS style.
test chore: Lint test files.
.codeclimate.yml chore: Add .codeclimate.yml
.eslintignore chore: Lint test files.
.eslintrc chore: Move to standard JS style.
.gitattributes chore: do not change pdf files line endings
.gitignore chore: add npm-debug.log to the gitignore
.mailmap chore: update .mailmap to remove duplicate contributors
.npmignore chore: ignore integration-tests etc.
.travis.yml chore(travis): Remove iojs-1
CHANGELOG.md chore: release v0.12.37
CODE_OF_CONDUCT.md chore: Add code of conduct
CONTRIBUTING.md chore: Add code of conduct
Gruntfile.coffee chore: Lint test files.
LICENSE chore: update copyright year range
README.md docs(readme): All support goes to gitter and the mailing list
config.tpl.coffee style(init): remove trailing whitespace from generated config file
config.tpl.js chore: Move to standard JS style.
config.tpl.ls style(init): remove trailing whitespace from generated config file
credentials fix sauce access token
karma-completion.sh style(completion): fix the comment
mocha-watch-debug.sh chore: added mocha debug task
mocha-watch.sh chore: add shell script to start mocha watcher
package.json chore: release v0.12.37
requirejs.config.tpl.coffee fix(init): Make the requirejs config template normalize paths
requirejs.config.tpl.js fix(init): Make the requirejs config template normalize paths
thesis.pdf chore: add my thesis
wallaby.js chore: support wallabyjs for karma tests

README.md

Karma

js-standard-style npm version npm downloads

Build Status Code Climate Dependency Status devDependency Status

A simple tool that allows you to execute JavaScript code in multiple real browsers.

The main purpose of Karma is to make your test-driven development easy, fast, and fun.

Help and Support

For questions and support please use the mailing list or Gitter. The issue tracker is for bug reports and feature discussions only.

When should I use Karma?

  • You want to test code in real browsers.
  • You want to test code in multiple browsers (desktop, mobile, tablets, etc.).
  • You want to execute your tests locally during development.
  • You want to execute your tests on a continuous integration server.
  • You want to execute your tests on every save.
  • You love your terminal.
  • You don't want your (testing) life to suck.
  • You want to use Istanbul to automagically generate coverage reports.
  • You want to use RequireJS for your source files.

But I still want to use _insert testing library_

Karma is not a testing framework, nor an assertion library. Karma just launches a HTTP server, and generates the test runner HTML file you probably already know from your favourite testing framework. So for testing purposes you can use pretty much anything you like. There are already plugins for most of the common testing frameworks:

If you can't find an adapter for your favourite framework, don't worry and write your own. It's not that hard and we are here to help.

Which Browsers can I use?

All the major browsers are supported, if you want to know more see the browsers page.

Troubleshooting

See FAQ.

I want to use it. Where do I sign?

You don't need to sign anything but here are some resources to help you to get started...

Obligatory Screencast.

Every serious project has a screencast, so here is ours. Just click here and let the show begin.

Installation.

See installation.

Using it.

See configuration.

This is so great. I want to help.

Please, see contributing.

Why did you create this?

Throughout the development of AngularJS, we've been using JSTD for testing. I really think that JSTD is a great idea. Unfortunately, we had many problems with JSTD, so we decided to write our own test runner based on the same idea. We wanted a simple tool just for executing JavaScript tests that is both stable and fast. That's why we use the awesome Socket.io library and Node.js.

My boss wants a license. So where is it?

MIT License

Something went wrong with that request. Please try again.