Skip to content

feat: add integrations page #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/en/intro/integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Integrations

Cycle ORM is designed to be flexible and extensible, allowing it to integrate seamlessly with various PHP frameworks. This capability ensures developers can leverage Cycle ORM's powerful features across different environments, enhancing productivity and maintaining consistency in data management practices. Below are the currently available official and community-supported integration packages that facilitate the use of Cycle ORM within other PHP frameworks, including its official integration with the Spiral framework.

## Spiral

Cycle ORM serves as the official ORM for the Spiral framework, supported by the `spiral/cycle-bridge` package. This integration is optimized for Spiral applications, ensuring compatibility and performance, especially with the [RoadRunner](https://roadrunner.dev) server for long-running applications.

- **GitHub Repository**: [spiral/cycle-bridge](https://github.com/spiral/cycle-bridge)
- **Documentation**: [Spiral Framework Integration](https://spiral.dev/docs/basics-orm)
- **Maintained By**: [SpiralScout](https://spiralscout.com)

## Yii 3

The Yii Framework integration is officially supported through a package maintained by the [YiiSoft](https://www.yiiframework.com). This package ensures that Cycle ORM works seamlessly with Yii, providing a robust solution for managing database operations within Yii applications.

- **GitHub Repository**: [yiisoft/yii-cycle](https://github.com/yiisoft/yii-cycle)
- **Documentation**: [Guide and Usage](https://github.com/yiisoft/yii-cycle/tree/master/docs/guide/en)

## Laravel

For Laravel developers seeking a DataMapper ORM solution, the Laravel Cycle ORM Adapter provides an essential bridge. Managed by the [WayOfDev Organization](https://github.com/wayofdev), this package seamlessly integrates Cycle ORM into Laravel projects. It addresses the framework's absence of a native DataMapper type ORM, offering a comprehensive and efficient database management experience that complements Laravel's ecosystem.

- **GitHub Repository**: [wayofdev/laravel-cycle-orm-adapter](https://github.com/wayofdev/laravel-cycle-orm-adapter)
- **Documentation**: [Setup and Configuration](https://laravel-cycle-orm-adapter.wayof.dev)

## Contributing

Cycle ORM's integration ecosystem is continuously evolving, thanks to the contributions from the community. If you have developed an integration package for Cycle ORM or wish to contribute to existing packages, we encourage you to share your work with the community. For more information on contributing, please refer to our [contribution guidelines](/docs/en/contributing.md).

## Support

For questions, issues, or support regarding Cycle ORM and its integrations, please visit our [GitHub Issues](https://github.com/cycle/orm/issues) page or join our [Discord community](https://discord.gg/TFeEmCs). Our community and maintainers are always ready to help you get the most out of Cycle ORM.
1 change: 1 addition & 0 deletions docs/en/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"readme": "Table of Contents",
"intro/about": "About Cycle ORM",
"intro/install": "Installation",
"intro/integrations": "Integrations",
"intro/upgrade": "Upgrade Guide",
"contributing": "Contributing",
"issue-test-case": "Issue with Test Case",
Expand Down