-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
208 lines (152 loc) · 8.07 KB
/
index.html
File metadata and controls
208 lines (152 loc) · 8.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<title>Friends of Ouro - Event Sourcing & KurrentDB PHP Libraries</title>
<link rel="stylesheet" href="stylesheets/styles.css">
<link rel="stylesheet" href="stylesheets/pygment_trac.css">
<script src="javascripts/scale.fix.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
<div class="wrapper">
<header>
<h1 class="header">Friends of Ouro</h1>
<p class="header">Event Sourcing & <a href="https://kurrent.io/">KurrentDB</a> PHP Libraries</p>
<ul>
<li class="download"><a class="buttons" href="https://packagist.org/packages/friendsofouro/">Packagist</a></li>
<li><a class="buttons github" href="https://github.com/FriendsOfOuro">GitHub</a></li>
</ul>
<p class="header">Open source PHP libraries for event sourcing</p>
</header>
<section>
<h1>
<a name="friends-of-ouro" class="anchor" href="#friends-of-ouro"><span class="octicon octicon-link"></span></a>Friends of Ouro</h1>
<p>Open source PHP libraries for event sourcing and <a href="https://kurrent.io/">KurrentDB</a> (formerly EventStoreDB) integration. Our mission is to provide modern, type-safe, and well-tested PHP tools for building event-driven applications.</p>
<h2>
<a name="our-projects" class="anchor" href="#our-projects"><span class="octicon octicon-link"></span></a>Our Projects</h2>
<h3>
<a name="kurrentdb-php-core" class="anchor" href="#kurrentdb-php-core"><span class="octicon octicon-link"></span></a>🏗️ KurrentDB PHP Core</h3>
<p><strong>The main PHP client library for KurrentDB HTTP API</strong></p>
<p><a href="https://github.com/FriendsOfOuro/kurrentdb-php-core/actions/workflows/php_8.yml"><img src="https://github.com/FriendsOfOuro/kurrentdb-php-core/actions/workflows/php_8.yml/badge.svg" alt="PHP 8"></a>
<a href="https://packagist.org/packages/friendsofouro/kurrentdb-core"><img src="https://img.shields.io/packagist/v/friendsofouro/kurrentdb-core.svg" alt="Latest Stable Version"></a></p>
<ul>
<li>✅ Modern PHP 8.4+ with strict typing</li>
<li>✅ Stream management (read, write, delete)</li>
<li>✅ Optimistic concurrency control</li>
<li>✅ Forward/backward iteration with page limits</li>
<li>✅ Batch operations & HTTP caching</li>
<li>✅ PSR-7/PSR-18 compliant</li>
<li>✅ Comprehensive error handling</li>
</ul>
<pre><code>composer require friendsofouro/kurrentdb-core</code></pre>
<p><a href="https://github.com/FriendsOfOuro/kurrentdb-php-core">📚 Documentation & Source Code</a></p>
<h3>
<a name="kurrentdb-php" class="anchor" href="#kurrentdb-php"><span class="octicon octicon-link"></span></a>📦 KurrentDB PHP (Metapackage)</h3>
<p><strong>Convenience package with good defaults</strong></p>
<p>This metapackage includes <code>kurrentdb-core</code> with sensible default dependencies, perfect for quick setup.</p>
<pre><code>composer require friendsofouro/kurrentdb-php</code></pre>
<p><a href="https://github.com/FriendsOfOuro/kurrentdb-php">🔗 GitHub Repository</a></p>
<h3>
<a name="kurrentdb-bundle" class="anchor" href="#kurrentdb-bundle"><span class="octicon octicon-link"></span></a>🎯 KurrentDB Symfony Bundle</h3>
<p><strong>Symfony 7.3+ integration bundle</strong></p>
<p>Seamless integration of KurrentDB into your Symfony applications with dependency injection, configuration management, and more.</p>
<ul>
<li>✅ Symfony 7.3+ compatibility</li>
<li>✅ Service container integration</li>
<li>✅ Configuration management</li>
<li>✅ Auto-wiring support</li>
</ul>
<pre><code>composer require friendsofouro/kurrentdb-bundle</code></pre>
<p><a href="https://github.com/FriendsOfOuro/kurrentdb-bundle">📘 Bundle Documentation</a></p>
<h3>
<a name="kurrentdb-docker-example" class="anchor" href="#kurrentdb-docker-example"><span class="octicon octicon-link"></span></a>🐳 KurrentDB Docker Example</h3>
<p><strong>Simple Docker setup for local development</strong></p>
<p>Ready-to-use Docker Compose configuration for running KurrentDB locally. Perfect for development and testing.</p>
<ul>
<li>🚀 Single command setup: <code>docker-compose up</code></li>
<li>🌐 Web UI available at <a href="http://localhost:2113/">http://localhost:2113/</a></li>
<li>🔐 Default credentials: admin/changeit</li>
<li>💾 Persistent data storage</li>
</ul>
<p><a href="https://github.com/FriendsOfOuro/kurrentdb-docker-example">🐋 Get Docker Setup</a></p>
<h3>
<a name="http-batch-contract" class="anchor" href="#http-batch-contract"><span class="octicon octicon-link"></span></a>🔌 HTTP Batch Contract</h3>
<p><strong>PSR-18 interface contracts for batch HTTP requests</strong></p>
<p>Defines the standard interfaces for handling multiple HTTP requests efficiently. Used internally by KurrentDB libraries for optimized batch operations.</p>
<ul>
<li>✅ PSR-18 compliant interfaces</li>
<li>✅ Type-safe batch response handling</li>
<li>✅ Exception aggregation support</li>
<li>✅ Filtering and transformation utilities</li>
</ul>
<pre><code>composer require friendsofouro/http-batch-contract</code></pre>
<p><a href="https://github.com/FriendsOfOuro/http-batch-contract">🔗 Contract Documentation</a></p>
<h3>
<a name="http-batch-guzzle" class="anchor" href="#http-batch-guzzle"><span class="octicon octicon-link"></span></a>⚡ HTTP Batch Guzzle</h3>
<p><strong>Guzzle implementation for efficient batch HTTP processing</strong></p>
<p>High-performance Guzzle-based implementation of the HTTP batch contracts with caching support and concurrent request handling.</p>
<ul>
<li>✅ Concurrent request processing</li>
<li>✅ Built-in HTTP caching support</li>
<li>✅ Filesystem and APCu cache adapters</li>
<li>✅ Exception handling and retry logic</li>
</ul>
<pre><code>composer require friendsofouro/http-batch-guzzle</code></pre>
<p><a href="https://github.com/FriendsOfOuro/http-batch-guzzle">🚀 Implementation Guide</a></p>
<h2>
<a name="getting-started" class="anchor" href="#getting-started"><span class="octicon octicon-link"></span></a>Getting Started</h2>
<h3>Quick Example</h3>
<pre><code>use KurrentDB\EventStore;
use FriendsOfOuro\Http\Batch\Guzzle\GuzzleHttpClient;
use KurrentDB\WritableEvent;
use KurrentDB\ValueObjects\Identity\UUID;
use GuzzleHttp\Psr7\HttpFactory;
// Create client
$httpFactory = new HttpFactory();
$httpClient = new GuzzleHttpClient();
$eventStore = new EventStore(
$httpFactory->createUri('http://admin:changeit@127.0.0.1:2113'),
$httpFactory, // UriFactory
$httpFactory, // RequestFactory
$httpClient
);
// Write events
$event = new WritableEvent(
new UUID(),
'user-registered',
['userId' => '123', 'email' => 'user@example.com']
);
$version = $eventStore->writeToStream('user-123', $event);
// Read events
foreach ($eventStore->forwardStreamFeedIterator('user-123') as $entry) {
echo "Event: " . $entry->getEvent()->getType() . "\n";
}
</code></pre>
<h2>
<a name="requirements" class="anchor" href="#requirements"><span class="octicon octicon-link"></span></a>Requirements</h2>
<ul>
<li>PHP 8.4 or higher</li>
<li>KurrentDB server instance</li>
<li>Composer for package management</li>
</ul>
<h2>
<a name="contributing" class="anchor" href="#contributing"><span class="octicon octicon-link"></span></a>Contributing</h2>
<p>We welcome contributions! Each repository has its own contributing guidelines:</p>
<ul>
<li><a href="https://github.com/FriendsOfOuro/kurrentdb-php-core/blob/main/CONTRIBUTING.md">kurrentdb-php-core Contributing Guide</a></li>
<li><a href="https://github.com/FriendsOfOuro/kurrentdb-bundle">kurrentdb-bundle Issues</a></li>
</ul>
<p>Feel free to open issues, submit pull requests, or discuss improvements in our GitHub repositories.</p>
</section>
<footer>
<p><small>This project is not endorsed by Kurrent Ltd.</small></p>
</footer>
</div>
<!--[if !IE]><script>fixScale(document);</script><![endif]-->
</body>
</html>