{"id":13669318,"url":"https://github.com/antonioribeiro/tddd","last_synced_at":"2025-04-08T09:10:35.998Z","repository":{"id":23666809,"uuid":"27037779","full_name":"antonioribeiro/tddd","owner":"antonioribeiro","description":"A Laravel Continuous Integration Package","archived":false,"fork":false,"pushed_at":"2023-09-06T20:35:11.000Z","size":4681,"stargazers_count":719,"open_issues_count":8,"forks_count":57,"subscribers_count":29,"default_branch":"master","last_synced_at":"2025-04-01T08:31:32.447Z","etag":null,"topics":["codeception","dashboard","developer-tools","laravel","laravel-dusk","php","phpspec","phpunit","tester","testing","watcher"],"latest_commit_sha":null,"homepage":null,"language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antonioribeiro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2014-11-23T15:59:02.000Z","updated_at":"2025-03-20T21:48:56.000Z","dependencies_parsed_at":"2024-01-17T04:19:01.852Z","dependency_job_id":null,"html_url":"https://github.com/antonioribeiro/tddd","commit_stats":{"total_commits":293,"total_committers":8,"mean_commits":36.625,"dds":0.04778156996587035,"last_synced_commit":"f6c69e165bbba870d4a3259c9e6baed2cb5e51fb"},"previous_names":["antonioribeiro/ci"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antonioribeiro%2Ftddd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antonioribeiro%2Ftddd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antonioribeiro%2Ftddd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antonioribeiro%2Ftddd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antonioribeiro","download_url":"https://codeload.github.com/antonioribeiro/tddd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809964,"owners_count":20999816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codeception","dashboard","developer-tools","laravel","laravel-dusk","php","phpspec","phpunit","tester","testing","watcher"],"created_at":"2024-08-02T08:01:09.695Z","updated_at":"2025-04-08T09:10:35.908Z","avatar_url":"https://github.com/antonioribeiro.png","language":"Vue","funding_links":[],"categories":["PHP","Vue"],"sub_categories":[],"readme":"# TDDD - Test Driven Development Dashboard\n### A Self-Hosted TDD Dashboard \u0026 Tests Watcher \n\n[![Latest Stable Version](https://img.shields.io/packagist/v/pragmarx/tddd.svg?style=flat-square)](https://packagist.org/packages/pragmarx/tddd)\n[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md) \n[![Downloads](https://img.shields.io/packagist/dt/pragmarx/tddd.svg?style=flat-square)](https://packagist.org/packages/pragmarx/tddd) \n[![Code Quality](https://img.shields.io/scrutinizer/g/antonioribeiro/tddd.svg?style=flat-square)](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master) \n[![Build](https://img.shields.io/scrutinizer/build/g/antonioribeiro/tddd.svg?style=flat-square)](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master) \n[![StyleCI](https://styleci.io/repos/27037779/shield)](https://styleci.io/repos/27037779)\n\n## What is it?\n\nTDD Dashboard, is an app (built as a Laravel PHP package) to watch and run all your tests during development. It supports any test framework working on terminal, and comes with some testers (PHPUnit, phpspec, behat, Jest, AVA...) preconfigured, but you can easily add yours, just tell it where the executable is and it's done. It also shows the progress of your tests, let you run a single test or all of them, and open your favorite code editor (PHPStorm, VSCode, Sublime Text, etc.) going right to the failing line of your test. If your test framework generate screenshots, it is also able to show it in the log page, with all the reds and greens you are used to see in your terminal.\n\nIt uses Laravel as motor, but supports (and has been tested with) many languages, frameworks and testing frameworks:\n\n* [PHPUnit](https://phpunit.de/)\n* [Laravel \u0026 Laravel Dusk](https://laravel.com/docs/5.5/dusk)\n* [Codeception](http://codeception.com/)\n* [phpspec](http://www.phpspec.net/en/stable/)\n* [Behat](http://behat.org/en/latest/)\n* [atoum](http://atoum.org/)\n* [Jest](https://facebook.github.io/jest/)\n* [AVA](https://github.com/avajs/ava)\n* [React](https://reactjs.org/)\n* [Ruby on Rails](http://guides.rubyonrails.org/testing.html)\n* [Nette Tester](https://tester.nette.org/)\n* [Symfony](https://symfony.com/doc/current/testing.html)\n\n## Features\n\n* Project List: click a project link to see all its tests.\n* Open files directly in your source code editor (PHPStorm, Sublime Text...).\n* Error log with source code linked, go strait to the error line in your source code.\n* Enable/disable a test. Once disabled if the watcher catches a change in resources, that test will not fire.\n* Real time test state: \"idle\", \"running\", \"queued\", \"ok\" and \"failed\".\n* \"Show\" button, to display the error log of failed tests.\n* Highly configurable, watch anything and test everything!\n \n### Videos\n\n- [Preview](https://www.youtube.com/watch?v=sO_aDf3xCgE)\n- [Installing](https://youtu.be/AgkKCLNiV8w)\n- [VueJS Preview](https://youtu.be/HAdfLYArk_A)\n- [Laravel Dusk Preview](https://youtu.be/ooF4oLD9U7Q)\n\n### Screenshots\n\n#### Dashboard\n\n![visits](https://raw.githubusercontent.com/antonioribeiro/tddd/master/docs/dashboard.png)\n\n#### Error Log\n![visits](https://raw.githubusercontent.com/antonioribeiro/tddd/master/docs/errorlog1.png)\n\n![visits](https://raw.githubusercontent.com/antonioribeiro/tddd/master/docs/errorlog2.png)\n\n![visits](https://raw.githubusercontent.com/antonioribeiro/tddd/master/docs/errorlog3.png)\n\n## Command Line Interface\n\nThe Artisan commands **Watcher** and **Tester** are responsible for watching resources and firing tests, respectively:\n\n### Watcher\n\nKeep track of your files and enqueue your tests every time a project or test file is changed. If a project file changes, it will enqueue all your tests, if a test file changes, it will enqueue only that particular test. This is how you run it:\n\n``` bash\nphp artisan tddd:watch\n```\n\n### Tester\n\nResponsible for taking tests from the run queue, execute it and log the results. Tester will only execute enabled tests. This is how you run it:\n\n``` bash\nphp artisan tddd:test\n```\n\n### Notifications\n\nIt uses JoliNotif, so if it's not working on macOS, you can try installing terminal-notifier:\n\n``` bash\nbrew install terminal-notifier\n```\n\n## Test Framework Compatibility\n\nThis package was tested and is known to be compatible with\n\n* [Codeception](http://codeception.com/)\n* [PHPUnit](https://phpunit.de/)\n* [phpspec](http://www.phpspec.net/)\n* [behat](http://docs.behat.org/)\n* [atoum](https://github.com/atoum/atoum)\n* [Nette Tester](http://tester.nette.org/en/)\n\n## Installing\n\n#### TL;DR\n\n``` bash\nlaravel new tddd\ncd tddd\ncomposer require pragmarx/tddd\nphp artisan vendor:publish --provider=\"PragmaRX\\Tddd\\Package\\ServiceProvider\"\nvalet link tddd\n# configure database on your .env\nphp artisan migrate\nphp artisan tddd:watch \u0026 php artisan tddd:work \u0026\nopen http://tddd.dev/tests-watcher/dashboard\n``` \n\n### Examples \u0026 Starter App\n\nFor lots of examples, check [this starter app](https://github.com/antonioribeiro/tests-watcher-starter), which will also help you create an independent dashboard for your tests.\n\n### The long version\n\nRequire it with [Composer](http://getcomposer.org/):\n\n``` bash\ncomposer require pragmarx/tddd\n```\n\nCreate a database, configure on your Laravel app and migrate it\n\n``` bash\nphp artisan migrate\n```\n\nPublish Ci configuration:\n\nOn Laravel 4.*\n\nAdd the service provider to your app/config/app.php:\n\n``` php\n'PragmaRX\\Tddd\\Package\\ServiceProvider',\n```\n\n``` bash\nphp artisan config:publish pragmarx/tddd\n```\n\nOn Laravel 5.*\n\n``` bash\nphp artisan vendor:publish --provider=\"PragmaRX\\Tddd\\Package\\ServiceProvider\"\n```\n\n## Example of projects\n\n### Laravel Dusk\n\n``` php\n'project bar (dusk)' =\u003e [\n    'path' =\u003e $basePath,\n    'watch_folders' =\u003e [\n        'app',\n        'tests/Browser'\n    ],\n    'exclude' =\u003e [\n        'tests/Browser/console/',\n        'tests/Browser/screenshots/',\n    ],\n    'depends' =\u003e [],\n    'tests_path' =\u003e 'tests',\n    'suites' =\u003e [\n        'browser' =\u003e [\n            'tester' =\u003e 'dusk',\n            'tests_path' =\u003e 'Browser',\n            'command_options' =\u003e '',\n            'file_mask' =\u003e '*Test.php',\n            'retries' =\u003e 0,\n        ],\n    ],\n],\n```\n\n## Troubleshooting\n\n#### Tests are running fine in terminal but failing in the dashboard? \n\nYou have first to remember they are being executed in isolation, and, also, the environment is not exactly the same, so things like a cache and session may affect your results. \n\n## Requirements\n\n- Laravel 4.1+ or 5\n- PHP 5.3.7+\n\n## Author\n\n[Antonio Carlos Ribeiro](http://twitter.com/iantonioribeiro)\n\n## License\n\nLaravel Ci is licensed under the BSD 3-Clause License - see the `LICENSE` file for details\n\n## Contributing\n\nPull requests and issues are welcome.\n\n\n\n\u003c!-- [![Coverage](https://img.shields.io/scrutinizer/coverage/g/antonioribeiro/tddd.svg?style=flat-square)](https://scrutinizer-tddd.com/g/antonioribeiro/tddd/?branch=master) --\u003e \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantonioribeiro%2Ftddd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantonioribeiro%2Ftddd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantonioribeiro%2Ftddd/lists"}