Skip to content

Commit 5871698

Browse files
committed
Create CONTRIBUTING.md
1 parent f9b5b65 commit 5871698

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

CONTRIBUTING.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to Laravel Echo! Your contributions help make this project better for everyone.
4+
5+
Echo is maintained as a monorepo using [pnpm workspaces](https://pnpm.io/workspaces). Below you'll find an overview of the repository and how to get your development environment running.
6+
7+
> **Note:** You'll need **pnpm version 10 or higher**. If you're unsure which version you have, run `pnpm -v`.
8+
9+
## Repository Overview
10+
11+
```
12+
echo/
13+
├── packages/
14+
│ ├── laravel-echo/ Core library
15+
│ ├── react/ React hooks
16+
│ │ └── tests/ React tests
17+
│ └── vue/ Vue hooks
18+
│ └── tests/ Vue Tests
19+
```
20+
21+
## Getting Started
22+
23+
Clone the repository and install the dependencies:
24+
25+
```sh
26+
git clone https://github.com/laravel/echo.git echo
27+
cd echo
28+
pnpm install
29+
```
30+
31+
Then, start the development environment:
32+
33+
```sh
34+
pnpm dev
35+
```
36+
37+
This builds the core library and of the package variants, and starts a file watcher that will automatically rebuild each package when changes are made.
38+
39+
If you prefer, you can also start individual watchers from each package directory. For example:
40+
41+
```sh
42+
cd packages/laravel-echo && pnpm dev
43+
cd packages/react && pnpm dev
44+
cd packages/vue && pnpm dev
45+
```
46+
47+
> **Note:** The core package (`packages/laravel-echo`) must always be running, as all adapters depend on it.
48+
49+
## Running Tests
50+
51+
Run all tests:
52+
53+
```sh
54+
pnpm test
55+
```
56+
57+
Run the test suite for a specific adapter:
58+
59+
```sh
60+
cd packages/laravel-echo && pnpm test
61+
cd packages/react && pnpm test
62+
cd packages/vue && pnpm test
63+
```

0 commit comments

Comments
 (0)