wp-theme/README.md

64 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2015-12-11 14:04:11 +01:00
# wp-theme
2016-03-19 01:25:23 +01:00
> WordPress theme for ascribe's landing page and blog
2015-12-11 14:04:11 +01:00
## Prerequisites
- node & npm
- composer
```bash
npm i && composer install
2015-12-11 14:04:11 +01:00
```
## Development
On top of compiling css & js files, this starts a local, live-reloading server with BrowserSync:
```bash
gulp
```
The task assumes the following:
- WordPress exposed via MAMP under http://localhost:8888
The following compiles css & js files only:
```bash
gulp build
```
2016-03-19 01:25:23 +01:00
## Deployment
2016-03-19 01:25:23 +01:00
Deployment happens via rsync'ing the theme folder `./ascribe/` over SSH, as defined in the [deployment script](deploy.sh).
If you have SSH access to the server, you can do a deployment by calling the deployment script:
```bash
# do a fresh build of the CSS & JS
gulp build
# Then deploy
./deploy.sh
```
It requires the following environment variables to be defined, which is done in the deployment script:
variable | description
2016-03-21 11:41:02 +01:00
---|---
2018-05-31 11:10:41 +02:00
`$ASCRIBE_DEPLOY_SRC` | source of CI build artifacts
`$ASCRIBE_DEPLOY_USER` | user for connecting to deploy server
`$ASCRIBE_DEPLOY_HOST` | hostname of deploy server
`$ASCRIBE_DEPLOY_PATH` | path to deploy into on the server, should be `PATH_ON_SERVER/wp-content/themes/`
## Server documentation
Site is hosted on an AWS EC2 instance with WordPress running on nginx.
Option | Server path
---|---
Host | `ec2-52-57-166-130.eu-central-1.compute.amazonaws.com`
WordPress installation | `/var/www/ascribe-wp/`
Active theme | `/var/www/ascribe-wp/wp-content/themes/ascribe/`