-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from kathunk/chris/ver-31-spike-plan-docs
Blatantly steal Livewire's docs structure
- Loading branch information
Showing
4 changed files
with
57 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,6 @@ | |
build | ||
composer.lock | ||
coverage | ||
docs | ||
phpunit.xml | ||
phpstan.neon | ||
testbench.yaml | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
[ | ||
{ | ||
"section": "Getting Started", | ||
"items": [ | ||
{ | ||
"title": "Quickstart", | ||
"uri": "quickstart", | ||
"file": "quickstart.md" | ||
}, | ||
{ | ||
"title": "What you absolutely need to know", | ||
"uri": "need-to-know", | ||
"file": "need-to-know.md" | ||
} | ||
] | ||
}, | ||
{ | ||
"section": "Event Sourcing Crash Course", | ||
"items": [] | ||
}, | ||
{ | ||
"section": "Event Lifecycle", | ||
"items": [] | ||
}, | ||
{ | ||
"section": "Migrating from other packages", | ||
"items": [] | ||
} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Verbs is generally very simple to use. But there are a few things that you really need to know to | ||
get started using event sourcing in Verbs. | ||
|
||
## The "Rules" | ||
|
||
### Rule 1: ID === Global Identity | ||
|
||
In Verbs, IDs are **global identity**. This means that whatever IDs you use, they should be completely | ||
unique regardless of what database you happen to be using. The easiest way to do that is to use | ||
**Snowflakes**, which are unique IDs that also fit into a traditional database's "big int" primary key. | ||
|
||
### Rule 2: Keep your events separate from your models |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Let’s get you started with Verbs! | ||
|
||
## Prerequisites | ||
|
||
First, make sure you have the following installed: | ||
|
||
- Laravel version 10 or later | ||
- PHP version 8.1 or later | ||
|
||
## Install Verbs | ||
|
||
Install Verbs using composer: | ||
|
||
```shell | ||
composer require kathunk/verbs | ||
``` |