This project contains all the UI stuff for TDDbin, it is runnable separately without any backend and aims to provide all components modularly. Please get involved on trello and vote or add ideas, comments, etc.. The highest ranked ideas will be the priority for us to implement.
The short version using Nix (light-weight docker)
nix-shell -p nodejs-7_x and a nix-shell with Node.js installed will open.
Now, continue in the next chapter.
The short version
In your shell:
export KATAS_SERVICE_DOMAIN=katas.service.domain.local, the domain where to find the katas locally (is
git clone firstname.lastname@example.org:tddbin/tddbin-frontend.git; cd tddbin-frontend; npm install; npm run build; npm start
The long version
In order to run this project locally make sure you have at least nodejs 0.10 installed
node --versionshould say so and do the following:
git clone email@example.com:tddbin/tddbin-frontend.gitclone the repo on your machine
cd tddbin-frontendgo into the directory where the project was cloned into
npm installinstalls all dependencies into the
npm testruns all the tests of the project
Now you can
export KATAS_SERVICE_DOMAIN=katas.service.domain.local, the domain where to find the katas locally (live it has this value
npm run buildfor the first time and
npm startstarts watchify which continuously updates the built files
and open the built version in the browser. Be sure to open the
through a URL served by a local web server, such as an apache, nginx, etc.
Using the katas service
All pre-built katas are hosted in katas-service repo. Which gets deployed to http://katas.tddbin.com from where all the katas can be loaded and which can be updated independently, micro-service style :).
Do I need it?
If you want to work on the katas-service repo and want to load the katas into
tddbin you might want to set up both repos to work with each other.
Other than that there is no real need to set up katas-service.
How to set it up
You don't need the katas-service to run locally, tddbin works also fully-functional without it.
If you also want to use the katas-service locally, clone the repo and make it available so that the env variable
KATAS_SERVICE_DOMAIN points to where to find the
served by the built katas-service.
How to contribute
In order to contribute please provide a pull request, add a description to what your code does and how it is useful. It will be commented, discussed, maybe you need to adapt things and then it might be merged.
The execution of tests takes place in a separate component, which can be hooked in where needed. This way adding a new test runner (e.g. qunit, tap, etc.) will be easy as long as it complies to the API that a test runner has to provide.
It is in this repo, but is not finished. Due to jasmine's stubborn architecture that doesn't allow to reinstanciate it for a new test run as it would be needed for a single page app I just left it ... it's basically unusable :(. To try what it currently can do run the examples/test-runner/jasmine.html in your browser.
The mocha runner is integrated and will most probably become the default runner. For an example navigate in your browser to the examples/test-runner directory.
Mocha is assertion API agnostic, it brings it's own assert() function by default, that can be used. By adding plugins various other styles can be provided. See below which ones come with it.
Jasmine-style (currently not working, see code)
It is enhanced with referee, which provides jasmine-style expect methods. The tests can be written the same way as with jasmine (for the biggest part) - at least all standard matchers are available, for details see the docs.
This architecture allows to add any kind of runner now. The easiest way for now is to duplicate the mocha runner and the example and get one up and file it as a pull request.