README.md

# ationframework

[![Build Status](http://ci.digitalmediauconn.org:8080/buildStatus/icon?job=ATION Site - Staging)](http://ci.digitalmediauconn.org:8080/job/ATION Site - Staging)

Putting this into wordpress.

## Vagrant/Docker

Choices for local development are Docker and Vagrant.

```
# Replace {env} with your desired environment, most likely "local"
docker-compose -f docker-compose-{env}.yml up -d
```

Wordpress development on [Vagrant](https://www.vagrantup.com/docs/installation/)

```
vagrant box add ubuntu/trusty64
vagrant up
```

The above will create a local site at [http://ation.local](http://ation.local/) that points to the `www` folder.

<!-- ## Production

Using AWS at the moment.  You will need to configure `aws` and `ecs-cli` to deploy.  After making changes and appspec is good:

```
aws deploy push --application-name ation --description "Your description" --ignore-hidden-files --s3-location s3://dmd-ation/Revision.zip --source .
```

Then you will have to deploy with CodeDeploy on the console. -->

## Development

Development started with [node](https://nodejs.org/en/) v5, and also utilizes [composer](https://getcomposer.org/doc/00-intro.md/).

```
cd www/wp-content/themes/ation2016
npm install
composer install
```

Then use `gulp` to develop, it watches the `src/images/`, `src/styles/`, and `src/scripts/` folders and compiles their production version to the `static/` directory.

## Navigating the Code

This site is based off the Timber (Twig x Wordpress) library.  It seems a bit daunting at first but it is significantly easier than writing native Wordpress code into theme files.  Any questions about Timber functionality can be answered in their [docs](http://timber.github.io/timber/#getting-started) or in their [github wiki](https://github.com/timber/timber/wiki).

Our relevant project structure is as follows:

```
/ationframework
    /docker-compose-{env}.yml       # Docker Compose Files per environment
    /www
        /wp-env                     # Holds environment specific wordpress variables (db)
        /wp-content
            /themes
                /ation2016          # Holds all relevant theme files
                    /page.php       # All logic for pages held here
                    /functions.php  # Theme specific options, video shortcode, script loading
                    /package.json   # Holds information for npm dependencies
                    /gulpfile.js    # Holds information for gulp build tasks
                    /src            # Asset images, styles, scripts for development
                    /static         # Everything from /src gets compiled here for production
                    /templates      # All twig page templates and partials
                    /views          # Additional pluggable partials
```

## Syncing Media

From local machine to remote (replacing SSHALIAS with your ssh alias or user@host):

```
cd uploads/directory
# For mac/linux
rsync -avz --rsh=ssh ./ SSHALIAS:/var/www/ation.develop.digitalmediauconn.org/public_html/www/wp-content/uploads
```

From remote to local machine (replacing SSHALIAS with your ssh alias or user@host):

```
cd uploads/directory
# For mac/linux
rsync -avz --rsh=ssh SSHALIAS:/var/www/ation.develop.digitalmediauconn.org/public_html/www/wp-content/uploads/* .
# For windows
scp -r SSHALIAS:/var/www/ation.develop.digitalmediauconn.org/public_html/www/wp-content/uploads /path/to/local/ationframework/www/wp-content
```

## Builds

We use BUILDKITE for managing deployments.  See [https://buildkite.com](https://buildkite.com).

## Contact

[bk@uconn.edu](mailto:bk@uconn.edu)