From 4792e210445889ee345f687261eab4be3a63e327 Mon Sep 17 00:00:00 2001
From: Nabeel Shahzad <nshahzad@gmail.com>
Date: Sun, 11 Jun 2017 08:15:15 -0500
Subject: [PATCH] added some installation instructions

---
 .env.example | 16 ++++++++++++++++
 README.md    | 35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 00000000..d8afcdd8
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,16 @@
+APP_ENV=dev
+APP_KEY=base64:ve66Z5Kt/zTN3p++0zOPu854PHfZkwJE5VuoFAlzHtI=
+APP_DEBUG=true
+APP_LOG_LEVEL=debug
+APP_URL=http://localhost
+
+DB_CONNECTION=local
+DB_HOST=localhost
+DB_PORT=3306
+DB_DATABASE=
+DB_USERNAME=
+DB_PASSWORD=
+
+CACHE_DRIVER=array
+SESSION_DRIVER=array
+QUEUE_DRIVER=sync
diff --git a/README.md b/README.md
index 214d4e63..2c5b13d1 100755
--- a/README.md
+++ b/README.md
@@ -6,6 +6,39 @@
 
 The next phpvms version built on the laravel framework. work in progress. If you're looking for the old, phpVMS classic, it's [available here](https://github.com/nabeelio/phpvms_v2).
 
-## license
+# installation
+
+run the following commands. for right now, we're running on sqlite. for mysql, set `DB_CONNECTION` to `mysql` in the `.env` file, and skip the `sqlite3` step below.
+
+```
+cp .env.example .env
+composer install --no-interaction
+sqlite3 database/testing.sqlite ""
+php artisan migrate:refresh --seed
+```
+
+then point your webserver to the `/public` folder. for example, in nginx:
+
+```
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server ipv6only=on;
+
+    root /var/www/laravel/public;
+    index index.php index.html index.htm;
+
+    server_name localhost;
+
+    location / {
+            try_files $uri $uri/ =404;
+    }
+}
+```
+
+see [this article](https://www.digitalocean.com/community/tutorials/how-to-install-laravel-with-an-nginx-web-server-on-ubuntu-14-04) for more detailed instructions.
+
+(TODO: redis information, etc)
+
+# license
 
 phpVMS is open-sourced software licensed under the [The 3-Clause BSD License](https://opensource.org/licenses/BSD-3-Clause).