=================
:: Development ::
=================

Prerequisite:
1. Install a web server; E.G. WAMP or XAMPP
2. Install composer. https://getcomposer.org/
3. Edit php.ini and make sure
   UPLOAD_MAX_FILESIZE & POST_MAX_SIZE is atleast 50mb

Setup:
1. Put checkout repo into www of web server.
   E.G. C:\wamp\www\hogie if using WAMP

2. Open command prompt/terminal and navigate to the repo root folder.

   Then execute: composer install

   This will install all the nessesary vendor/thirdparty packages using
   the locked versions defined in the "composer.lock" file.
   
3. Make a copy of ".env.example" file and name it ".env"

4. Setup a new mysql database following the credentials defined in ".env" file.

   Then execute: php artisan migrate

   This will generate the proper database tables.

5. Initialize admin user for login:
   php artisan db:seed --class Smarch\Watchtower\Seeds\WatchtowerTableSeeder

6. Login to the admin:
   user: admin@change.me
   password: password

For more information on development, see:
https://laravel.com/docs/5.2/

======================
:: General use link ::
======================

Webpage: http://localhost/<hogie_folder_name>/public
Backend: http://localhost/<hogie_folder_name>/public/watchtower

====================
:: Basic concepts ::
====================

Folder Structure:
"config"    : module configuration files. They are loaded into a giant config dictionary accessible with the function config();
"public"    : all files accessible by browser goes here.
"app"       : The controller part of the MVC concept. Most development will go into "app/Http/Controllers"
"resources" : This is where the View part of the MVC concept lies.
              Generally development will touch the "resources/views" folder. They are where webpage templates lies

TODO: More info here to get started!

================
:: Deployment ::
================

push repository to staging (Currently using: https://LiquidRockGames@bitbucket.org/LiquidRockGames/hogie-web.git)

Run Putty and connect to:
host: 69.195.124.217
port: 22
use private key: hogie-ssh-private.ppk

cd ~/hogie_web
git pull
php artisan migrate

Brain dump:
- Ideally, we should make a special key with read permission to pull directly from server.
  No FTP crap or we will face difficulty maintaining the website.
- .env file needs to change the APP_ENV variable from "local" to "deployed"
  This is to hide the "Register" link from the admin(watchtower) page.
- We should provide a .htaccess modrewrite to support domain root at "public" folder.


================
:: Going Live ::
================

Login to server:
rename public_html -> public_html.backup
rename www -> public_html

Done.

Taking site down should be as simple as doing the reverse.
We should probably make a shell script for this.