https://github.com/beyondcode/tinkerwell
Drivers, panels and tools for customizing Tinkerwell to your application.
https://github.com/beyondcode/tinkerwell
Last synced: 3 months ago
JSON representation
Drivers, panels and tools for customizing Tinkerwell to your application.
- Host: GitHub
- URL: https://github.com/beyondcode/tinkerwell
- Owner: beyondcode
- License: mit
- Created: 2023-08-16T09:51:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T15:49:27.000Z (7 months ago)
- Last Synced: 2025-03-30T05:03:46.756Z (3 months ago)
- Language: PHP
- Size: 57.6 KB
- Stars: 37
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tinkerwell Workbench
www.tinkerwell.app
Tinkerwell is a REPL on steroids. It allows you to run code snippets within the context of your application without
hitting the browser. It's the perfect companion to your favorite IDE and works with any framework – locally, via SSH,
Docker and even on Laravel Vapor.
This package contains helpful tools to customize Tinkerwell for your application.
**You do not need to install this package to customize Tinkerwell. Just copy the driver or tool you need into your
applications' [custom driver](https://tinkerwell.app/docs/4/extending-tinkerwell/custom-drivers) directory. However, if you want
to make use of
autocompletion while implementing your customization, it's helpful to install this package as a dev dependency.**
```
composer require --dev beyondcode/tinkerwell
```
## Drivers
When you open your project with Tinkerwell, one of the available drivers will be loaded and bootstrap your application
to prepare it for code execution within Tinkerwell. This repository holds all available drivers for Tinkerwell. If your
framework does not have a
specific driver yet, Tinkerwell will at least try and load your projects' autoload file.
If you have written a custom driver for a framework by yourself, feel free to open a PR and add it to this repository!
For more information about drivers, check out
the [documentation](https://tinkerwell.app/docs/4/extending-tinkerwell/custom-drivers).
## Panels
With Panels, Tinkerwell offers a concise and visually appealing way to get a snapshot of specific details about your
application.
For more information about panels, check out
the [documentation](https://tinkerwell.app/docs/4/extending-tinkerwell/panels).
## Themes
If you want to add a custom theme to Tinkerwell, you can find two example themes in the `src/themes` directory.
For more information about custom themes, check out
the [documentation](https://tinkerwell.app/docs/4/advanced-usage/custom-themes).
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Beyond Code](https://github.com/beyondcode)
- [Diana Scharf](https://github.com/mechelon)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.