theme-juice 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +33 -33
- data/lib/theme-juice/scaffold.rb +1 -1
- data/lib/theme-juice/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 13028727bc3d7b0d809e5be56abab24dbb6406ed
|
4
|
+
data.tar.gz: 2bce67655374ac66c52c61664568fee1cd2e7c23
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb1980616eebc102f4b54f9cba994a07ecdf06ec92d98cf9a78944de8545988810d640e0e3f01940fd42bb543d2c215d0c442056fa5b4810346fdf053750e0f2
|
7
|
+
data.tar.gz: 3c2daab95cabc9c8911a50fad390920c11e12978d81094de7174d422f0b108239dbec2599029198a04065b404139419d288495856ccb21fee7f52f53523cd7ed
|
data/README.md
CHANGED
@@ -1,80 +1,80 @@
|
|
1
|
-
# Theme Juice
|
2
|
-
Command line interface to scaffold out a new WordPress development environment and countless sites. Everybody loves one command setups, and
|
1
|
+
# Theme Juice [![Gem Version](https://badge.fury.io/rb/theme-juice.svg)](http://badge.fury.io/rb/theme-juice)
|
2
|
+
Command line interface to scaffold out a new WordPress development environment and countless sites. Everybody loves one command setups, and `tj` even does one command deployments too.
|
3
3
|
|
4
4
|
## Installation
|
5
5
|
* First, install [Vagrant](https://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/) for local development.
|
6
|
-
* Then, install [Composer](https://getcomposer.org/) and [WP-CLI](http://wp-cli.org/)
|
7
|
-
* Finally, you can run:
|
6
|
+
* Then, install [Composer](https://getcomposer.org/) and [WP-CLI](http://wp-cli.org/) (make sure they're executable).
|
7
|
+
* Finally, you can run: `$ gem install theme-juice-cli`
|
8
8
|
|
9
|
-
That
|
9
|
+
That`s it!
|
10
10
|
|
11
11
|
## Usage
|
12
12
|
|
13
13
|
#### List available commands:
|
14
|
-
List all commands for
|
15
|
-
|
14
|
+
List all commands for `tj`.
|
15
|
+
```bash
|
16
16
|
tj
|
17
|
-
|
17
|
+
```
|
18
18
|
|
19
19
|
#### Setup VVV:
|
20
20
|
This command will _only_ setup [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV). It will not prompt you to create a new site. _Note: This is automatically run when you create your first site._
|
21
|
-
|
21
|
+
```bash
|
22
22
|
tj init
|
23
|
-
|
23
|
+
```
|
24
24
|
|
25
25
|
#### Create a new development site:
|
26
|
-
Use this to create a new development site. It will automagically set up your entire development environment, including a local development site at
|
27
|
-
|
26
|
+
Use this to create a new development site. It will automagically set up your entire development environment, including a local development site at `http://<sites-dev-url>.dev` with WordPress installed and a fresh WP database. It will sync up your local site installation with the Vagrant VM. This task will also install and configure Vagrant/VVV into your `~/` directory if it has not already been installed. Site name is optional, as it will be asked for if not given.
|
27
|
+
```bash
|
28
28
|
tj create [<site-name>]
|
29
|
-
|
29
|
+
```
|
30
30
|
|
31
31
|
#### Setup an existing site:
|
32
|
-
Use this to setup an existing local site installation within the development environment. You will go through the setup process to create the necessary files for the VM, including
|
33
|
-
|
32
|
+
Use this to setup an existing local site installation within the development environment. You will go through the setup process to create the necessary files for the VM, including `vvv-hosts`, `vvv-nginx.conf`, and a fresh database (unless one already exists by the name chosen). Site name is optional, as it will be asked for if not given.
|
33
|
+
```bash
|
34
34
|
tj setup [<site-name>] # Alias for 'tj create [<site-name>] --bare'
|
35
|
-
|
35
|
+
```
|
36
36
|
|
37
37
|
#### Delete a site from the VM: _(Does not remove your local site)_
|
38
|
-
Use this to remove a site from your development environment. This is only remove files that were generated by
|
39
|
-
|
38
|
+
Use this to remove a site from your development environment. This is only remove files that were generated by `tj`. including the database setup, development url, and shared directories. _It will not touch your local files._
|
39
|
+
```bash
|
40
40
|
tj delete <site-name>
|
41
|
-
|
41
|
+
```
|
42
42
|
|
43
43
|
#### List all sites in the VM:
|
44
|
-
Use this to list all sites within your development environment that were generated by
|
45
|
-
|
44
|
+
Use this to list all sites within your development environment that were generated by `tj`.
|
45
|
+
```bash
|
46
46
|
tj list
|
47
|
-
|
47
|
+
```
|
48
48
|
|
49
49
|
#### Watch and compile assets: _(Guard)_
|
50
50
|
Use this to watch and compile assets with [Guard](https://github.com/guard/guard). This is simply a wrapper for Guard commands.
|
51
|
-
|
51
|
+
```bash
|
52
52
|
tj watch # Alias for 'bundle exec guard #{cmd}'
|
53
|
-
|
53
|
+
```
|
54
54
|
|
55
55
|
#### Use for managing development environment: _(Vagrant)_
|
56
56
|
Use this to easily manage your [Varying Vagrant Vagrants](https://github.com/Varying-Vagrant-Vagrants/VVV) development environment. This is simply a wrapper for Vagrant commands.
|
57
|
-
|
57
|
+
```bash
|
58
58
|
tj vm # Alias for 'cd ~/vagrant && vagrant #{cmd}'
|
59
|
-
|
59
|
+
```
|
60
60
|
|
61
61
|
#### Use for managing vendor dependencies: _(Composer)_
|
62
62
|
Use this to easily manage your [Composer](https://github.com/composer/composer) dependencies. This is simply a wrapper for Composer commands.
|
63
|
-
|
63
|
+
```bash
|
64
64
|
tj vendor # Alias for 'composer #{cmd}'
|
65
|
-
|
65
|
+
```
|
66
66
|
|
67
67
|
#### Use for managing deployment and migration: _(Capistrano)_
|
68
68
|
Use this to easily manage your deployment and migration with [Capistrano](https://github.com/capistrano/capistrano). This is simply a wrapper for Capistrano commands.
|
69
|
-
|
69
|
+
```bash
|
70
70
|
tj server # Alias for 'bundle exec cap #{cmd}'
|
71
|
-
|
71
|
+
```
|
72
72
|
|
73
73
|
## Contributing
|
74
74
|
|
75
75
|
1. First, create an [issue](https://github.com/ezekg/theme-juice-cli/issues) for your proposed feature. If it's a bug fix, go right to step 2.
|
76
76
|
2. [Fork the repository](https://github.com/ezekg/theme-juice-cli/fork).
|
77
|
-
3. Create a new feature branch. (
|
78
|
-
4. Commit your changes. (
|
79
|
-
5. Push to the new branch. (
|
77
|
+
3. Create a new feature branch. (`git checkout -b my-new-feature`)
|
78
|
+
4. Commit your changes. (`git commit -am `Add some feature``)
|
79
|
+
5. Push to the new branch. (`git push origin my-new-feature`)
|
80
80
|
6. Create a new Pull Request.
|
data/lib/theme-juice/scaffold.rb
CHANGED
data/lib/theme-juice/version.rb
CHANGED