UNPKG

4.03 kBMarkdownView Raw
1<a name="README">[<img src="https://rawgithub.com/jasmine/jasmine/master/images/jasmine-horizontal.svg" width="400px" />](http://jasmine.github.io)</a>
2
3[![Build Status](https://travis-ci.org/jasmine/jasmine.svg?branch=master)](https://travis-ci.org/jasmine/jasmine)
4[![Open Source Helpers](https://www.codetriage.com/jasmine/jasmine/badges/users.svg)](https://www.codetriage.com/jasmine/jasmine)
5
6# A JavaScript Testing Framework
7
8Jasmine is a Behavior Driven Development testing framework for JavaScript. It does not rely on browsers, DOM, or any JavaScript framework. Thus it's suited for websites, [Node.js](http://nodejs.org) projects, or anywhere that JavaScript can run.
9
10Documentation & guides live here: [http://jasmine.github.io](http://jasmine.github.io/)
11For a quick start guide of Jasmine, see the beginning of [http://jasmine.github.io/edge/introduction.html](http://jasmine.github.io/edge/introduction.html)
12
13Upgrading from Jasmine 2.x? Check out the [3.0 release notes](https://github.com/jasmine/jasmine/blob/v3.0.0/release_notes/3.0.md) for a list of what's new (including breaking changes).
14
15## Contributing
16
17Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/master/.github/CONTRIBUTING.md)
18
19## Installation
20
21For the Jasmine NPM module:<br>
22[https://github.com/jasmine/jasmine-npm](https://github.com/jasmine/jasmine-npm)
23
24For the Jasmine Ruby Gem:<br>
25[https://github.com/jasmine/jasmine-gem](https://github.com/jasmine/jasmine-gem)
26
27For the Jasmine Python Egg:<br>
28[https://github.com/jasmine/jasmine-py](https://github.com/jasmine/jasmine-py)
29
30For the Jasmine headless browser gulp plugin:<br>
31[https://github.com/jasmine/gulp-jasmine-browser](https://github.com/jasmine/gulp-jasmine-browser)
32
33To install Jasmine standalone on your local box (where **_{#.#.#}_** below is substituted by the release number downloaded):
34
35* Download the standalone distribution for your desired release from the [releases page](https://github.com/jasmine/jasmine/releases)
36* Create a Jasmine directory in your project - `mkdir my-project/jasmine`
37* Move the dist to your project directory - `mv jasmine/dist/jasmine-standalone-{#.#.#}.zip my-project/jasmine`
38* Change directory - `cd my-project/jasmine`
39* Unzip the dist - `unzip jasmine-standalone-{#.#.#}.zip`
40
41Add the following to your HTML file:
42
43```html
44<link rel="shortcut icon" type="image/png" href="jasmine/lib/jasmine-{#.#.#}/jasmine_favicon.png">
45<link rel="stylesheet" type="text/css" href="jasmine/lib/jasmine-{#.#.#}/jasmine.css">
46
47<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/jasmine.js"></script>
48<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/jasmine-html.js"></script>
49<script type="text/javascript" src="jasmine/lib/jasmine-{#.#.#}/boot.js"></script>
50```
51
52## Supported environments
53
54Jasmine tests itself across many browsers (Safari, Chrome, Firefox, PhantomJS, Microsoft Edge, and new Internet Explorer) as well as nodejs. To see the exact version tests are run against look at our [.travis.yml](https://github.com/jasmine/jasmine/blob/master/.travis.yml)
55
56
57## Support
58
59* Search past discussions: [http://groups.google.com/group/jasmine-js](http://groups.google.com/group/jasmine-js)
60* Send an email to the list: [jasmine-js@googlegroups.com](mailto:jasmine-js@googlegroups.com)
61* View the project backlog at Pivotal Tracker: [http://www.pivotaltracker.com/projects/10606](http://www.pivotaltracker.com/projects/10606)
62* Follow us on Twitter: [@JasmineBDD](http://twitter.com/JasmineBDD)
63
64## Maintainers
65
66* [Gregg Van Hove](mailto:gvanhove@pivotal.io), Pivotal Labs
67
68### Maintainers Emeritus
69
70* [Davis W. Frank](mailto:dwfrank@pivotal.io), Pivotal Labs
71* [Rajan Agaskar](mailto:rajan@pivotal.io), Pivotal Labs
72* [Greg Cobb](mailto:gcobb@pivotal.io), Pivotal Labs
73* [Chris Amavisca](mailto:camavisca@pivotal.io), Pivotal Labs
74* [Christian Williams](mailto:antixian666@gmail.com), Cloud Foundry
75* Sheel Choksi
76
77Copyright (c) 2008-2018 Pivotal Labs. This software is licensed under the MIT License.