forked from galaxyofdrones/galaxyofdrones
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
98 additions
and
92 deletions.
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 |
---|---|---|
|
@@ -13,99 +13,9 @@ An open source multiplayer space strategy game. | |
|
||
The game story takes place in a virtual galaxy where randomly generated planets produce various raw materials which can be used by the Players to develop their infrastructure and fleet. In addition, players may trade with the Earth or engage in battles, so beyond various military arrangements, economic decisions should be taken as well. | ||
|
||
## Installation | ||
## Documentation | ||
|
||
### Step 1: Clone the repositroy | ||
|
||
``` | ||
git clone [email protected]:koodilab/galaxyofdrones-online.git | ||
``` | ||
|
||
### Step 2: Configure the database and redis connection | ||
|
||
``` | ||
cp .env.example .env | ||
``` | ||
|
||
### Step 3: Install the composer dependencies | ||
|
||
``` | ||
composer install --no-dev | ||
``` | ||
|
||
### Step 4: Set the application key | ||
|
||
``` | ||
php artisan key:generate | ||
``` | ||
|
||
### Step 5: Run the migrations and seeds | ||
|
||
``` | ||
php artisan migrate --seed | ||
``` | ||
|
||
### Step 6: Generate the Laravel Passport keys | ||
|
||
``` | ||
php artisan passport:keys | ||
``` | ||
|
||
### Step 7: Generate the starmap | ||
|
||
(estimated time: ~1 hour, estimated size: ~4 Gb) | ||
|
||
``` | ||
php artisan starmap:generate | ||
``` | ||
|
||
### Step 8: Run the Laravel Queue | ||
|
||
``` | ||
php artisan queue:work --sleep=1 --tries=3 | ||
``` | ||
|
||
### Step 9: Run the Laravel Scheduler | ||
|
||
``` | ||
* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1 | ||
``` | ||
|
||
### Step 10: Install and setup Laravel Echo Server | ||
|
||
(use the `/ws` as socket.io path) | ||
|
||
``` | ||
... | ||
"socketio": { | ||
"path": "/ws" | ||
} | ||
... | ||
``` | ||
|
||
### Step 11: Setup the websocket in webserver config | ||
|
||
(example nginx configuration) | ||
|
||
``` | ||
... | ||
location /ws { | ||
proxy_pass http://127.0.0.1:6001; | ||
proxy_http_version 1.1; | ||
proxy_set_header Upgrade $http_upgrade; | ||
proxy_set_header Connection 'upgrade'; | ||
proxy_set_header Host $host; | ||
proxy_cache_bypass $http_upgrade; | ||
} | ||
... | ||
``` | ||
|
||
### Step 12: Have fun | ||
|
||
``` | ||
username: koodilab | ||
password: havefun | ||
``` | ||
The initial documentation is available [on GitHub](https://github.com/koodilab/galaxyofdrones-online/tree/master/docs). | ||
|
||
## Security | ||
|
||
|
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,3 @@ | ||
# Documentation | ||
|
||
* [Installation](installation.md) |
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,93 @@ | ||
# Installation | ||
|
||
* Step 1: Clone the repositroy | ||
|
||
``` | ||
git clone [email protected]:koodilab/galaxyofdrones-online.git | ||
``` | ||
|
||
* Step 2: Configure the database and redis connection | ||
|
||
``` | ||
cp .env.example .env | ||
``` | ||
|
||
* Step 3: Install the composer dependencies | ||
|
||
``` | ||
composer install --no-dev | ||
``` | ||
|
||
* Step 4: Set the application key | ||
|
||
``` | ||
php artisan key:generate | ||
``` | ||
|
||
* Step 5: Run the migrations and seeds | ||
|
||
``` | ||
php artisan migrate --seed | ||
``` | ||
|
||
* Step 6: Generate the Laravel Passport keys | ||
|
||
``` | ||
php artisan passport:keys | ||
``` | ||
|
||
* Step 7: Generate the starmap | ||
|
||
(estimated time: ~1 hour, estimated size: ~4 Gb) | ||
|
||
``` | ||
php artisan starmap:generate | ||
``` | ||
|
||
* Step 8: Run the Laravel Queue | ||
|
||
``` | ||
php artisan queue:work --sleep=1 --tries=3 | ||
``` | ||
|
||
* Step 9: Run the Laravel Scheduler | ||
|
||
``` | ||
* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1 | ||
``` | ||
|
||
* Step 10: Install and setup Laravel Echo Server | ||
|
||
(use the `/ws` as socket.io path) | ||
|
||
``` | ||
... | ||
"socketio": { | ||
"path": "/ws" | ||
} | ||
... | ||
``` | ||
|
||
* Step 11: Setup the websocket in webserver config | ||
|
||
(example nginx configuration) | ||
|
||
``` | ||
... | ||
location /ws { | ||
proxy_pass http://127.0.0.1:6001; | ||
proxy_http_version 1.1; | ||
proxy_set_header Upgrade $http_upgrade; | ||
proxy_set_header Connection 'upgrade'; | ||
proxy_set_header Host $host; | ||
proxy_cache_bypass $http_upgrade; | ||
} | ||
... | ||
``` | ||
|
||
* Step 12: Have fun | ||
|
||
``` | ||
username: koodilab | ||
password: havefun | ||
``` |