https://github.com/leafsphp/router
🏚 router module for leaf PHP
https://github.com/leafsphp/router
leafphp php router
Last synced: 8 months ago
JSON representation
🏚 router module for leaf PHP
- Host: GitHub
- URL: https://github.com/leafsphp/router
- Owner: leafsphp
- Archived: true
- Created: 2021-10-23T02:00:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-02T10:32:43.000Z (about 1 year ago)
- Last Synced: 2025-04-22T00:24:37.241Z (8 months ago)
- Topics: leafphp, php, router
- Language: PHP
- Homepage: https://leafphp.dev/modules/router/
- Size: 46.9 KB
- Stars: 6
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
Leaf Router
Leaf router is the core routing engine which powers the Leaf PHP framework. Leaf router is now served as a serve-yourself module which can even be used outside the Leaf ecosystem.
**Leaf Router is still built into Leaf Core and doesn't need to be installed separately.**
## Installation
You can easily install Leaf using [Composer](https://getcomposer.org/).
```bash
composer require leafs/router
```
## Basic Usage
If you are using leaf router with Leaf, you can build your leaf apps just as you've always done:
```php
get("/", function () {
response()->json([
"message" => "Welcome!"
]);
});
// MATCH example
app()->match("GET", "/test", function () {
response()->json([
"message" => "Test!"
]);
});
app()->run();
```
If however, you are using leaf router outside of the leaf framework, you simply need to call these methods on the `Leaf\Router` object:
```php
"Welcome!"
]);
});
// MATCH example
Router::match("GET", "/test", function () {
echo json_encode([
"message" => "Test!"
]);
});
Router::run();
```
You may quickly test this using the built-in PHP server:
```bash
php -S localhost:8000
```
## 💬 Stay In Touch
- [Twitter](https://twitter.com/leafphp)
- [Join the forum](https://github.com/leafsphp/leaf/discussions/37)
- [Chat on discord](https://discord.com/invite/Pkrm9NJPE3)
## 📓 Learning Leaf 3
- Leaf has a very easy to understand [documentation](https://leafphp.dev) which contains information on all operations in Leaf.
- You can also check out our [youtube channel](https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw) which has video tutorials on different topics
- We are also working on codelabs which will bring hands-on tutorials you can follow and contribute to.
## 😇 Contributing
We are glad to have you. All contributions are welcome! To get started, familiarize yourself with our [contribution guide](https://leafphp.dev/community/contributing.html) and you'll be ready to make your first pull request 🚀.
To report a security vulnerability, you can reach out to [@mychidarko](https://twitter.com/mychidarko) or [@leafphp](https://twitter.com/leafphp) on twitter. We will coordinate the fix and eventually commit the solution in this project.
### Code contributors
## 🤩 Sponsoring Leaf
Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
And to all our existing cash/code contributors, we love you all ❤️
### Cash contributors
Aaron Smith
Peter Bogner
Vano
Casprine
Farhan Yahaya
Lucas Chaplain
## 🤯 Links/Projects
- [Aloe CLI](https://leafphp.dev/aloe-cli/)
- [Leaf Docs](https://leafphp.dev)
- [Leaf MVC](https://mvc.leafphp.dev)
- [Leaf API](https://api.leafphp.dev)
- [Leaf CLI](https://cli.leafphp.dev)
