theme-juice 0.11.7 → 0.11.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +16 -16
- data/lib/theme-juice/man/tj +2 -2
- data/lib/theme-juice/man/tj.txt +5 -7
- data/lib/theme-juice/version.rb +1 -1
- metadata +4 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9b3b2016c6969da7f6d2f9bec625f2f429ef1a5e
|
4
|
+
data.tar.gz: 39b2cee6ced64cbbfcaed0cdbc220c2c3b4dc0e0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c37e13612677d70079fb733fb7ae5141205a21556efa6755ee47b0d7b0d7d91d4bc87918a48b48129ef0e06c72aad748def1225889a364d24bab749d8415ad75
|
7
|
+
data.tar.gz: f7260da6df4b9ecdb5e1552fe568e2afb4e1fa2b96614538eacf650fd3c2c83fb6c08a48c9ccaea8651db57422abebd906d7887ae329059f24ed80cea3cd8c4c
|
data/README.md
CHANGED
@@ -14,7 +14,7 @@ _The master branch contains features currently in development, so don't expect i
|
|
14
14
|
[View our contributing guidelines to get started!](#contributing)
|
15
15
|
|
16
16
|
## What is it?
|
17
|
-
Theme Juice (`tj`) is a command line utility
|
17
|
+
Theme Juice (`tj`) is a command line utility that allows you to generate, manage and deploy new local WordPress development applications in seconds using Vagrant, utilizing an Apache fork of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) called [VVV-Apache](https://github.com/ericmann/vvv-apache.git) as the virtual machine.
|
18
18
|
|
19
19
|
## Requirements
|
20
20
|
**`tj` requires [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) to be able to create virtual machines for local development. Please download and install both of these before getting started.**
|
@@ -32,7 +32,7 @@ gem install theme-juice
|
|
32
32
|
|
33
33
|
_If you're going to be using [our starter theme](https://github.com/ezekg/theme-juice-starter), then I recommend checking out [it's dependencies](https://github.com/ezekg/theme-juice-starter#development-dependencies) before running your first `create`. That way, the build step doesn't fail._
|
34
34
|
|
35
|
-
|
35
|
+
### Create a new project
|
36
36
|
This will lead you through a series of prompts to set up required project information, such as name, location, theme, database info, etc. Using the specified information, it will run the installation process and set up a local development environment, if one hasn't already been set up. It will sync your local project location with the project
|
37
37
|
location within the VM, so you can run this from anywhere on your local system.
|
38
38
|
|
@@ -40,7 +40,7 @@ location within the VM, so you can run this from anywhere on your local system.
|
|
40
40
|
tj create
|
41
41
|
```
|
42
42
|
|
43
|
-
|
43
|
+
#### What happens on your first `create`?
|
44
44
|
`tj` will clone the selected VM to your `vm-path` (default path is `~/vagrant/`); after that finishes up, it will create all of the necessary project files, such as:
|
45
45
|
* `Customfile` containing DNS and synced folder settings
|
46
46
|
* `init-custom.sql` containing database setup
|
@@ -49,14 +49,14 @@ tj create
|
|
49
49
|
|
50
50
|
Once those things are done, `tj` will run the starter theme's installation (via the `Juicefile`, if present), and then finally provision the VM to put the new configuration into effect. If you've never used Vagrant before, the first provision might take awhile. After that's done, you should be able to access your new project at the specified url.
|
51
51
|
|
52
|
-
|
52
|
+
### Set up an existing project
|
53
53
|
This sets up an existing local project within the development environment. You will go through a series of prompts to create the necessary files. This command is essentially an alias for `tj create --bare`.
|
54
54
|
|
55
55
|
```
|
56
56
|
tj setup
|
57
57
|
```
|
58
58
|
|
59
|
-
|
59
|
+
### Removing a project
|
60
60
|
This will remove a project from your development environment. This will only remove files that were generated by `tj` i.e. the database setup, DNS setup, and other project configuration files.
|
61
61
|
|
62
62
|
It will not touch your local folders that were synced to the VM.
|
@@ -65,14 +65,14 @@ It will not touch your local folders that were synced to the VM.
|
|
65
65
|
tj delete
|
66
66
|
```
|
67
67
|
|
68
|
-
|
68
|
+
### Deploying a project
|
69
69
|
This will deploy a project to the passed `<stage>` using [Capistrano](http://capistranorb.com/). Head over to the [docs](http://themejuice.it/deploy) to get started with your first deployment.
|
70
70
|
|
71
71
|
```
|
72
72
|
tj deploy <stage>
|
73
73
|
```
|
74
74
|
|
75
|
-
|
75
|
+
### Want more?
|
76
76
|
Want to check out all of the various flags and features `tj` offers? Just ask `tj` for help, and you'll be greeted with a nice `man` page full of information about how to use just about everything.
|
77
77
|
|
78
78
|
```
|
@@ -94,7 +94,7 @@ Or, you can also check out [themejuice.it](http://themejuice.it) for a pretty we
|
|
94
94
|
1. [Help! It won't let me `git clone` anything!](#help-it-wont-let-me-git-clone-anything)
|
95
95
|
1. [Can I add my starter theme, ________?](#can-i-add-my-starter-theme-________)
|
96
96
|
|
97
|
-
|
97
|
+
### Is Windows supported?
|
98
98
|
Yes! But, since Windows doesn't support UTF-8 characters inside of the terminal, and is picky about ASCII colors, you'll probably have to run `tj` with a couple flags.
|
99
99
|
|
100
100
|
Something that has worked for me on one of my Windows machines is to run all commands through [git-scm](http://git-scm.com/downloads) with the `--boring --no-landrush` flags. This will disable all unicode characters and colors from being output, and will also disable [Landrush](https://github.com/phinze/landrush), which isn't fully supported on Windows.
|
@@ -110,7 +110,7 @@ In addition to that, `tj` uses the [OS gem](https://github.com/rdp/os) to sniff
|
|
110
110
|
|
111
111
|
_I don't regularly develop on Windows, so if you encounter any bugs, please let me know through a **well-documented** issue and I'll try my best to get it resolved._
|
112
112
|
|
113
|
-
|
113
|
+
### Can I use the original VVV instead of VVV-Apache?
|
114
114
|
Definitely. If you want to use `tj` with Nginx and the [original VVV](https://github.com/Varying-Vagrant-Vagrants/VVV), it's as simple as running `tj` with a few flags:
|
115
115
|
|
116
116
|
```bash
|
@@ -121,7 +121,7 @@ To use these permanently, set the appropriate `ENV` variables through your `.bas
|
|
121
121
|
|
122
122
|
_Note: Before running this, you might want to either choose a new `vm-path`, or destroy any existing VMs inside of your `~/vagrant` directory. If `tj` detects that a VM already installed, it will skip installing the new box._
|
123
123
|
|
124
|
-
|
124
|
+
### So, does that mean I can use any Vagrant box?
|
125
125
|
Yes and no; in order for `tj` to properly create a project, the Vagrant box needs to follow the same directory structure as VVV, and include a `Customfile`. Here is the required structure that `tj` needs in order to be able to create new projects:
|
126
126
|
|
127
127
|
```
|
@@ -152,10 +152,10 @@ Yes and no; in order for `tj` to properly create a project, the Vagrant box need
|
|
152
152
|
...
|
153
153
|
```
|
154
154
|
|
155
|
-
|
155
|
+
### What is a `Customfile`?
|
156
156
|
[It's a file that contains custom rules to add into the main `Vagrantfile`, without actually having to modify it](https://github.com/Varying-Vagrant-Vagrants/VVV/blob/develop/Vagrantfile#L208-L218). This allows us to easily modify the Vagrant box without causing merge conflicts if you were to update the VM source via `git pull`.
|
157
157
|
|
158
|
-
|
158
|
+
### What is a `Juicefile`?
|
159
159
|
A YAML configuration file (`Juicefile`) can be used to store commonly-used build scripts. Each command block sequence can be mapped to an individual project's build tool, allowing a streamlined set of commands to be used across multiple projects that utilize different tools. In the near-future, this will also house your deployment configuration.
|
160
160
|
|
161
161
|
Below is the config that comes baked into [our starter theme](https://github.com/ezekg/theme-juice-starter):
|
@@ -212,10 +212,10 @@ cmd3 "%arg4%"
|
|
212
212
|
|
213
213
|
You can specify an unlimited number of commands with an unlimited number of arguments; however, you should be careful with how this is used. Don't go including `sudo rm -rf %arg1%` in a command, while passing `/` as an argument. Keep it simple. These are meant to make your life easier by helping you manage build tools, not to do fancy scripting.
|
214
214
|
|
215
|
-
|
215
|
+
### Does `tj` handle deployments?
|
216
216
|
As of `0.11`, yes! Check out the [documentation](http://themejuice.it/deploy) to get started.
|
217
217
|
|
218
|
-
|
218
|
+
### Does `tj` support subdomain multi-sites?
|
219
219
|
If you're able to use [Landrush](https://github.com/phinze/landrush) for your DNS, then yes. All subdomains will resolve to their parent domain. Landrush comes pre-installed when you create your first project with `tj`. Having said that, unfortunately, if you're on Windows you'll probably have to manually add the subdomains due to Landrush not being fully supported. If you have the Windows chops, head over there and contribute to Landrush by squashing that bug. I'm sure he would appreciate it!
|
220
220
|
|
221
221
|
#### Can I access a project from another device (i.e. mobile)?
|
@@ -225,14 +225,14 @@ Once everything is good to go, you can access a project from another device on t
|
|
225
225
|
|
226
226
|
_If you're familiar with forwarding host ports on operating systems other than OSX, check out [this file](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/tasks/forward_ports.rb#L34-L51) and make a pull request so that everybody else can benefit from your smarts._
|
227
227
|
|
228
|
-
|
228
|
+
### Help! It won't let me `git clone` anything!
|
229
229
|
You most likely don't have [SSH-keys for GitHub set up correctly (if even at all)](https://help.github.com/articles/error-permission-denied-publickey/). Either set that up, or manually run `tj` with the appropriate flags corresponding to the problem-repository, swapping out `git@github.com:` for `https://github.com/`:
|
230
230
|
|
231
231
|
```
|
232
232
|
tj create --theme https://github.com/theme/repository.git --vm-box https://github.com/vm-box/repository.git
|
233
233
|
```
|
234
234
|
|
235
|
-
|
235
|
+
### Can I add my starter theme, ________?
|
236
236
|
Yes! Just update the `THEMES` constant inside [commands/create.rb](https://github.com/ezekg/theme-juice-cli/blob/master/lib/theme-juice/commands/create.rb#L7-L12) and make a pull request. I'll verify that the theme includes a `Juicefile` (not required, but preferred to automate build steps), and that everything looks solid. Until then (or if your theme is private), just run `tj create --theme https://your.repo/link/goes.here` to clone your theme.
|
237
237
|
|
238
238
|
## Contributing
|
data/lib/theme-juice/man/tj
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "TJ" "1" "
|
4
|
+
.TH "TJ" "1" "August 2015" "" "Theme Juice Manual"
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBtj\fR \- WordPress development made easy
|
@@ -10,7 +10,7 @@
|
|
10
10
|
\fBtj\fR [\fIcommand\fR] [\-\-flag=\fIarg\fR] [\-\-flag]
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
|
-
Theme Juice (tj(1)) is a command line utility
|
13
|
+
Theme Juice (tj(1)) is a command line utility that allows you to generate, manage and deploy new local WordPress development applications in seconds using vagrant(1), utilizing an apache(7) fork of vvv(7) called vvv\-apache(7) as the virtual machine\.
|
14
14
|
.
|
15
15
|
.SH "GLOBAL OPTIONS"
|
16
16
|
.
|
data/lib/theme-juice/man/tj.txt
CHANGED
@@ -9,12 +9,10 @@ SYNOPSIS
|
|
9
9
|
tj [command] [--flag=arg] [--flag]
|
10
10
|
|
11
11
|
DESCRIPTION
|
12
|
-
Theme
|
13
|
-
|
14
|
-
|
15
|
-
vvv-apache(7) as the
|
16
|
-
development projects. It also helps you manage dependencies and build
|
17
|
-
tools, and can even handle your deployments.
|
12
|
+
Theme Juice (tj(1)) is a command line utility that allows you to gener-
|
13
|
+
ate, manage and deploy new local WordPress development applications in
|
14
|
+
seconds using vagrant(1), utilizing an apache(7) fork of vvv(7) called
|
15
|
+
vvv-apache(7) as the virtual machine.
|
18
16
|
|
19
17
|
GLOBAL OPTIONS
|
20
18
|
--vm-box=repository
|
@@ -228,4 +226,4 @@ ENVIRONMENT
|
|
228
226
|
|
229
227
|
|
230
228
|
|
231
|
-
|
229
|
+
August 2015 TJ(1)
|
data/lib/theme-juice/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: theme-juice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.11.
|
4
|
+
version: 0.11.8
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ezekiel Gabrielse
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-08-
|
11
|
+
date: 2015-08-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: thor
|
@@ -122,10 +122,8 @@ dependencies:
|
|
122
122
|
- - ~>
|
123
123
|
- !ruby/object:Gem::Version
|
124
124
|
version: '10.4'
|
125
|
-
description:
|
126
|
-
|
127
|
-
generate/manage an unlimited number of development projects. It also helps you manage
|
128
|
-
dependencies and build tools, and can even handle your deployments.
|
125
|
+
description: tj is a command line utility that allows you to generate, manage and
|
126
|
+
deploy new local WordPress development applications in seconds using Vagrant.
|
129
127
|
email:
|
130
128
|
- ezekg@yahoo.com
|
131
129
|
executables:
|