Add instructions on how to run the tests
This commit is contained in:
parent
341fa9f616
commit
9da4ece76d
1 changed files with 15 additions and 0 deletions
15
README.md
15
README.md
|
@ -41,6 +41,8 @@ FAQ
|
||||||
Development
|
Development
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
|
Setup
|
||||||
|
^^^^^
|
||||||
Getting started with the development of Glowing Bear is really simple, partly because we don't have a build process (pure client-side JS, remember). All you have to do is clone the repository, fire up a webserver to host the files, and start fiddling around. You can try out your changes by reloading the page.
|
Getting started with the development of Glowing Bear is really simple, partly because we don't have a build process (pure client-side JS, remember). All you have to do is clone the repository, fire up a webserver to host the files, and start fiddling around. You can try out your changes by reloading the page.
|
||||||
|
|
||||||
Here's a simple example using the python simple web server:
|
Here's a simple example using the python simple web server:
|
||||||
|
@ -58,6 +60,19 @@ If you'd prefer a version hosted with HTTPS, GitHub serves that as well with an
|
||||||
|
|
||||||
You can also use the latest and greatest development version of Glowing Bear at [https://latest.glowing-bear.org/](https://latest.glowing-bear.org/).
|
You can also use the latest and greatest development version of Glowing Bear at [https://latest.glowing-bear.org/](https://latest.glowing-bear.org/).
|
||||||
|
|
||||||
|
Running the tests
|
||||||
|
^^^^^^^^^^^^^^^^^
|
||||||
|
Glowing Bear uses Karma and Jasmine to run its unit tests. To run the tests locally, you will first need to install `npm` and `bower` on your machine.
|
||||||
|
|
||||||
|
Once this is done, you will need to retrieve the necessary packages for testing Glowing-Bear:
|
||||||
|
|
||||||
|
`$ npm install`
|
||||||
|
|
||||||
|
Finally, you can run the tests:
|
||||||
|
|
||||||
|
`$ npm test`
|
||||||
|
|
||||||
|
|
||||||
Contributing
|
Contributing
|
||||||
------------
|
------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue