Installation instructions

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
index e33f404..e63875f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,41 @@
 # API
 RESTful PHP API for Botleagues
+
+# Installation
+* Create a new laravel project:
+
+        laravel new <name-of-folder>
+
+* Remove the default content:
+
+        php artisan fresh
+
+* Add the BotleaguesAPI package using composer
+
+* In `config/app.php`, add the following `ServiceProvider`s:
+
+  * `CamilStaps\BotleaguesApi\BotleaguesApiServiceProvider`
+  * `Dingo\Api\Provider\LaravelServiceProvider`
+
+* Publish the `api` and `botleaguesapi` configuration files from `camil-staps/botleagues-api`
+
+* In `config/api.php`, set `auth` to:
+
+        'auth' => [
+            'basic' => function ($app) {
+                return new Dingo\Api\Auth\Provider\Basic($app['auth']);
+            },
+            'token' => function ($app) {
+                return new \CamilStaps\BotleaguesApi\TokenAuthenticationProvider;
+            }
+        ],
+
+* In `config/botleaguesapi.php`, set `allowed_origin` to (an array of) the allowed origin(s) of API requests. Use `*` for a wildcard.
+
+* In `/.env`, set the appropriate configuration values:
+
+  * `APP_ENV`, `APP_DEBUG`, `APP_KEY`, `APP_URL`
+  * `DB_HOST`, `DB_DATABASE`, `DB_USERNAME`, `DB_PASSWORD`
+  * `API_VERSION=v1`, `API_DEBUG`, `API_DOMAIN`
+
+After this, you should be good to go. Add configuration settings and the like as usual.