|
6 | 6 |
|
7 | 7 | Beaver is a real-time messaging server. With beaver you can easily build scalable in-app notifications, realtime graphs, multiplayer games, chat applications, geotracking and more in web applications and mobile apps. |
8 | 8 |
|
| 9 | +<p align="center"> |
| 10 | + <img alt="Beaver Single Node" src="https://raw.githubusercontent.com/Clivern/Beaver/master/assets/charts/single_node.png" /> |
| 11 | +</p> |
| 12 | + |
9 | 13 | ## Documentation |
10 | 14 |
|
11 | 15 | ### Config & Run The Application |
@@ -63,7 +67,24 @@ $ ./beaver -config=config.dist.yml |
63 | 67 | Also running beaver with docker still an option. |
64 | 68 |
|
65 | 69 | ```bash |
66 | | -$ cp config.yml config.dist.yml |
| 70 | +$ mkdir -p $HOME/srv/beaver |
| 71 | +$ mkdir -p $HOME/srv/beaver/configs |
| 72 | +$ mkdir -p $HOME/srv/beaver/logs |
| 73 | + |
| 74 | +$ cd $HOME/srv/beaver |
| 75 | + |
| 76 | +$ curl -OL https://raw.githubusercontent.com/Clivern/Beaver/master/Dockerfile |
| 77 | +$ curl -OL https://raw.githubusercontent.com/Clivern/Beaver/master/docker-compose.yml |
| 78 | +$ curl -OL https://raw.githubusercontent.com/Clivern/Beaver/master/config.yml |
| 79 | + |
| 80 | +$ cp config.yml ./configs/config.dist.yml |
| 81 | +$ rm config.yml |
| 82 | +# Update log.path to be the absolute path to config file on host machine ($HOME/srv/beaver/logs) |
| 83 | +$ sed -i "s|var/logs|${HOME}/srv/beaver/logs|g" ./configs/config.dist.yml |
| 84 | +$ sed -i "s|localhost:6379|redis:6379|g" ./configs/config.dist.yml |
| 85 | + |
| 86 | +# Build and run containers |
| 87 | +$ cd $HOME/srv/beaver/ |
67 | 88 | $ docker-compose build |
68 | 89 | $ docker-compose up -d |
69 | 90 | ``` |
@@ -312,12 +333,46 @@ Socket("ws://localhost:8080/ws/$ID/$TOKEN"); |
312 | 333 |
|
313 | 334 | [](https://travis-ci.org/Clivern/Beaver) |
314 | 335 | [](https://github.com/Clivern/Beaver/blob/master/LICENSE) |
315 | | -[](https://github.com/Clivern/Beaver/releases) |
| 336 | +[](https://github.com/Clivern/Beaver/releases) |
316 | 337 | [](https://goreportcard.com/report/github.com/Clivern/Beaver) |
317 | 338 |
|
| 339 | +## For contributors |
| 340 | + |
| 341 | +To run beaver locally for development or even testing, please follow the following: |
| 342 | + |
| 343 | +```bash |
| 344 | +# Use src/github.com/clivern/beaver |
| 345 | +$ mkdir -p $GOPATH/src/github.com/clivern/beaver |
| 346 | +$ git clone https://github.com/Clivern/Beaver.git $GOPATH/src/github.com/clivern/beaver |
| 347 | +$ cd $GOPATH/src/github.com/clivern/beaver |
| 348 | + |
| 349 | +# Create a feature branch |
| 350 | +$ git branch feature/x |
| 351 | +$ git checkout feature/x |
| 352 | + |
| 353 | +$ export GO111MODULE=on |
| 354 | +$ cp config.yml config.dist.yml |
| 355 | +$ cp config.yml config.test.yml |
| 356 | + |
| 357 | +# Add redis to config.test.yml and config.dist.yml |
| 358 | + |
| 359 | +# to run beaver |
| 360 | +$ go run beaver.go |
| 361 | +$ go build beaver.go |
| 362 | + |
| 363 | +# To run test cases |
| 364 | +$ make ci |
| 365 | +``` |
| 366 | + |
| 367 | +Then Create a PR with the master branch. |
318 | 368 |
|
319 | 369 | ## Changelog |
320 | 370 |
|
| 371 | +* Version 1.1.2: |
| 372 | +``` |
| 373 | +Update Docs. |
| 374 | +``` |
| 375 | + |
321 | 376 | * Version 1.1.1: |
322 | 377 | ``` |
323 | 378 | Fix Dockerfile. |
|
0 commit comments