You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<imgwidth="456"src="https://raw.githubusercontent.com/wayofdev/laravel-cycle-orm-adapter/master/assets/logo.gh-light-mode-only.png#gh-light-mode-only"alt="Logo for Light Mode">
5
+
<imgwidth="456"src="https://raw.githubusercontent.com/wayofdev/laravel-cycle-orm-adapter/master/assets/logo.gh-dark-mode-only.png#gh-dark-mode-only"alt="Logo for Dark Mode">
<ahref="https://packagist.org/packages/wayofdev/laravel-cycle-orm-adapter"><imgalt="Commits since latest release"src="https://img.shields.io/github/commits-since/wayofdev/laravel-cycle-orm-adapter/latest?style=flat-square"></a>
<imgwidth="320"src="assets/on-white-bg.png#gh-light-mode-only"alt="CycleORM + WayOfDev + Laravel Logo for Light GitHub Mode">
29
+
<imgwidth="320"src="assets/on-black-bg.png#gh-dark-mode-only"alt="CycleORM + WayOfDev + Laravel Logo for Dark GitHub Mode">
31
30
</div>
32
31
33
32
<br>
34
33
35
34
# Laravel Cycle ORM Adapter
36
35
37
-
Package fully integrates [Cycle ORM](https://cycle-orm.dev) into [Laravel](https://laravel.com) framework.
36
+
Unlock the full potential of [Domain-Driven Design](https://en.wikipedia.org/wiki/Domain-driven_design) in your Laravel projects with the [wayofdev/laravel-cycle-orm-adapter](https://github.com/wayofdev/laravel-cycle-orm-adapter) — the adapter package that seamlessly integrates the capabilities of [CycleORM](https://cycle-orm.dev)— DataMapper ORM into [Laravel Framework](https://laravel.com).
If you **like/use** this package, please consider **starring** it. Thanks!
38
+
This adapter bridges the gap between Laravel's rapid development capabilities and Cycle ORM's Data Mapper features, enabling you to craft complex, domain-centric applications, with separation of concerns, and a clear distinction between the domain model and the persistence layer.
43
39
44
40
<br>
45
41
46
-
## 💿 Installation
47
-
48
-
### → Using Composer
49
-
50
-
Require as dependency:
51
-
52
-
```bash
53
-
$ composer req wayofdev/laravel-cycle-orm-adapter
54
-
```
42
+
If you **like/use** this package, please consider **starring** ⭐️ it. Thanks!
|`cycle:orm:render`| Render available CycleORM schemas.<br /> `--no-color` Display output without colors. |
86
-
|`cycle:orm:sync`| Sync Cycle ORM schema with database without intermediate migration (risk operation). |
48
+
The full documentation for the package is available at [https://laravel-cycle-orm-adapter.wayof.dev](https://laravel-cycle-orm-adapter.wayof.dev).
87
49
88
50
<br>
89
51
90
-
## 🧪 Running Tests
91
-
92
-
### → PHPUnit Tests
93
-
94
-
To run tests, run the following command:
95
-
96
-
```bash
97
-
$ make test
98
-
```
99
-
100
-
### → Static Analysis
101
-
102
-
Code quality using PHPStan:
103
-
104
-
```bash
105
-
$ make stan
106
-
```
107
-
108
-
### → Coding Standards Fixing
52
+
## 🤝 Contributing
109
53
110
-
Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:
54
+
Contributions are welcome!
111
55
112
-
```bash
113
-
$ make cs-fix
114
-
```
56
+
If you would like to contribute to the package, please see the [Contributing Guide](https://laravel-cycle-orm-adapter.wayof.dev/contributing) file for more information.
115
57
116
58
<br>
117
59
@@ -133,7 +75,7 @@ Created in **2022** by [lotyp / wayofdev](https://github.com/wayofdev)
133
75
134
76
* The official [spiral/cycle-bridge](https://github.com/spiral/cycle-bridge) for Spiral Framework
135
77
136
-
* Alternative implementation of Cycle ORM for Laravel — [wakebit/laravel-cycle](https://github.com/wakebit/laravel-cycle)
78
+
* Alternative implementation of Cycle ORM for Laravel — [wakebit/laravel-cycle](https://github.com/wakebit/laravel-cycle) (abandoned)
If you would like to contribute to this project, please open an issue or a pull request. We are always looking for ways to improve the project and would love to hear your ideas.
6
+
7
+
The latest changes are always in master branch, so please make your Pull Request against that branch.
8
+
9
+
## 💻 Workflow
10
+
11
+
<Callouttype="warning">
12
+
Please feature/fix/update... into individual PRs (not one changing everything)
13
+
</Callout>
14
+
15
+
- Create a github fork.
16
+
- On your fork, create a branch, make the changes, commit and push.
17
+
- Create a pull-request to the master branch of this repository.
18
+
19
+
## 🧾 Checklist
20
+
21
+
### → If Applicable
22
+
23
+
- tests should be included as a part of your PR
24
+
- run `make hooks` to install the git hooks and pre-commit checks
25
+
- run `make test` or `make up && make ssh && vendor/bin/pest` to run them.
26
+
-`make lint` should be run to ensure the code is properly formatted and phpstan should be run to ensure the code is properly typed.
27
+
- documentation should be updated, please provide the corresponding documentation as well and make it part of the Pull Request
28
+
29
+
## ✉️ Git Message Format
30
+
31
+
This repo adheres to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
32
+
Commit messages are enforced through [commitizen](https://github.com/commitizen-tools/commitizen) and a [pre-commit](https://pre-commit.com), please use `make hooks` to install them.
33
+
34
+
This leads to more readable messages that are easy to follow when looking through the project history and also allows to generate changelogs automatically.
35
+
36
+
### → Allowed prefixes for commit messages
37
+
38
+
-**feat** — A new feature
39
+
-**fix** — A bug fix
40
+
-**perf** — A code change that improves performance
41
+
-**docs** — Documentation only changes
42
+
-**style** — Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)
43
+
-**deps** — Changes to the package.json or package-lock.json
44
+
-**refactor** — A code change that neither fixes a bug nor adds a feature
45
+
-**ci** — Changes to our CI configuration files and scripts
46
+
-**test** — Adding missing tests or correcting existing tests
47
+
-**revert** — Reverting a previous commit
48
+
-**build** — Changes that affect the build system or external dependencies (example scopes: pnpm, renovate, github actions)
49
+
-**chore** — Other changes that don't modify src or test files
50
+
-**security** — A code change that fixes a security issue
51
+
52
+
## 🔓 Security Vulnerabilities
53
+
54
+
If you discover a security vulnerability within this package, please send an e-mail to WayOfDev via the@wayof.dev. All security vulnerabilities will be promptly addressed.
55
+
56
+
## 🤝 Code of Conduct
57
+
58
+
We are using the [Contributor Covenant](https://www.contributor-covenant.org/) as our Code of Conduct, to keep discussion open and inclusive. Please, take a moment to read and follow our [Code of Conduct](https://github.com/wayofdev/laravel-cycle-orm-adapter/blob/master/.github/CODE_OF_CONDUCT.md).
0 commit comments