Feature/zero config setup #115

MetarDev · 2018-09-21T11:47:16Z

Still a WIP, opening a PR so this is all tracked.

Updated setup process for boilerplate that should be as simple and intuitive as possible while working on all platforms.

Currently it's 1 script (npm run setup) for setting everything up, after which user can follow the manual WordPress wizard install (by going to website's local url) or try the automatic setup depending on his local dev setup.

Would appreciate any feedback on intuitiveness of this.

Currently done

Reworked the setup.sh script so that it's now done in JS (no more bash)
rename.jsnow works no matter how many times you run it (saves old state to theme-manifest.json)
Added a default theme-manifest.json with initial values we replace using rename.js

To do

Output user's pass when creating him
Add some validation to user input (for example: only allow lowercase and hyphens for package name, etc)
Make the installation pretty ( chalk, some character art, emojis and removing unnecessary output )
Test on Windows (doesn't use bash anymore so it should be all good, also running composer using npx)
Create a Vagrant setup script

dingo-d · 2018-09-21T12:10:10Z

bin/setup-wp.js

+  dbPass: "wp",
+  wpUser: "ivan.grginov",
+  wpPass: "wp-pass",
+  siteName: "ImeStranice"


This is a test or? If any default text will be placed it should be in English :)

Temp stuff, there's really no need to set any defaults here, will remove. 👍

dingo-d · 2018-09-21T12:11:53Z

wp-info.json

+  "db-name": "infinum_boilerplate_dev",
+  "db-user": "wp",
+  "db-pass": "wp",
+  "wp-user": "ivan.grginov",


I'm fine with having your name, but it would be safer to use something totally generic, like infinum.user

…e old one.

MetarDev · 2018-09-23T10:06:31Z

Changes in last push

Added the WP install part after the initial setup (wp core install, wp config create and wp theme activate) depending on the user's local dev environment
It's now possible to have a working install (with DB and everything) with just 1 call npm run setup on VVV (still need to implement the wp installation part for other local setup - as it is now it just tells you to do it manually by going to your local website url and you will see the WP's 5-min wizard setup)
Reworked the update / renaming functions / scripts so they're all async(mostly just so they work with ora)
Reworked the rename script completely with new styling

To Do

Add "Create database if it doesn't exist" part before wp config create
Add some basic compatibility check for setups other than VVV (for example check if we're able to connect to mysql using "best guess" credentials for a particular setup - already using this with VVV - If not, prompt user and check again)
Skip setup steps if they're not needed (for example wp core download, as it is now if wp core exists the script will exit with an error - ideally it would just skip to the next part)
Check if search / replace is working with hidden files

dingo-d · 2018-09-23T11:48:38Z

README.md

@@ -12,6 +12,8 @@ This repository contains all the tools you need to start building a modern WordP

 First you need to install WordPress locally, using any of the local development environment you prefer. You can use XAMPP, MAMP, WAMP, VVV, Docker or Laravel Valet. You'll also need to have [Node.js](https://nodejs.org/en/), [Composer](https://getcomposer.org/) and [WP-CLI](https://wp-cli.org/) installed.

+**Note regarding `Windows` - If you're installing this on `Windows` and you're using `XAMPP`, use `XAMPP` shell (Control Panel -> Shell) rather than `cmd` **


This isn't rendered as bold. A better approach imo would be to add this as a subheading like:

Windows installation

If you're installing this on Windows, and you are using XAMPP, use XAMPP shell (Control Panel -> Shell) rather than the Windows command line prompt.

Changed this a bit so it no longer needs to be bolded.

dingo-d · 2018-09-23T11:50:49Z

README.md

@@ -66,18 +68,18 @@ Once you're done with the above setup (no matter which method you used), run `np



At the top where the ## Initial Setup is, we should add a note that if you are running from the vagrant ssh, these are all installed (node, composer and wp-cli)

Also for the manual part, besides running npm start, shouldn't composer installbe ran as well? Line 41

You still need wp-cli for vagrant (since wp core download is run outside vagrant). And you don't actually need composer regardless (at least not for installation) since we're running it using npx.

As for composer install, that is done just after renaming (actually it's update not install). (1. npm install, 2. renaming, 3. npx composer update, 4. wp core donwload)

dingo-d · 2018-12-05T10:49:07Z

readme.txt

@@ -0,0 +1,106 @@
+=== Infinum WordPress Boilerplate ===
+Contributors: mustra, dingo_bastard, ivangrginov
+Tags: Starter Theme, Webpack, Node, NodeJS, npm, npx, Build Process, Autoprefixr, SCSS, SASS, LESS, Babel, Browsersync, Accessibility Ready, Custom Colors, Custom Header, Custom Logo, Custom Menu, Editor Style, Featured Images, Flexible Header, Footer Widgets, One Column, Theme Options, Translation Ready, Two Columns


Be very careful when adding Accessibility Ready tag. As any theme submitted with this tag has to go through a special review on wordpress.org.

Also, there seem to be some nonstandard tags here, which could trigger some reviewers:

Rule about tags in style.css and description
Theme tags

👍 Removed most of the tags since we don't support pretty much anything in the backend without coding it yourself :)

dingo-d · 2018-12-05T10:56:55Z

readme.txt

+
+= Requirements =
+
+* PHP 7 or greater (recommended: PHP 7 or greater)


(recommended: PHP 7.2 or greater) ?

dingo-d · 2018-12-27T17:59:40Z

OMFG the readme! ❤️ ❤️ 😄

I'd only change one thing: the aliasing for the phpcs. We should add to composer.json the scripts that look like this (the alias can be changed):

"scripts" : {
  "check-cs": "@php ./vendor/bin/phpcs --extensions=php --ignore=/vendor/",
  "fix-cs": "@php ./vendor/bin/phpcbf --extensions=php --ignore=/vendor/",
}

That way you can just run (from where the composer is setup for development)

composer check-cs .

Or specify the directory, and you'll have linting that's fully working. Aliasing can cause some issues, especially if you have globally installed phpcs- the path won't be pulled from the root of your project but the global installation and in case you are not keeping it up to date that can be an issue, also the phpcs.xml.dist won't be picked up from the root of your project.

Other than that really awesome work on the readme, looks sick 😄 👍

MetarDev · 2018-12-27T18:16:46Z

Tested it and seems to work great, I'll all for it! Added the scripts and changed the readme to reflect the changes.

Regarding the readme, still need to add the updated Boilerplate graphics when I get them.

…ound.

Fix override globals issue.

…lerplate into feature/zero-config-setup

Ivan Grginov added 11 commits September 20, 2018 12:01

Default manifest file.

efcbb54

rename.js using manifest.json

74ef776

Use old package name as theme name

36c9d00

Renamed manifest.json file to theme-manifest.json

01a7453

2 setup scripts and everything works

f755d07

Require files script.

6bf04f9

Small tweaks.

6c6b99b

Updated the readme

6805e9e

Renamed the script

ccad759

Not using this file.

a244312

Small readme changes.

3cf07ac

MetarDev added enhancement labels Sep 21, 2018

MetarDev added this to the 3.0.0 milestone Sep 21, 2018

MetarDev self-assigned this Sep 21, 2018

dingo-d reviewed Sep 21, 2018

View reviewed changes

Ivan Grginov added 9 commits September 21, 2018 14:20

Possible fix for windows.

f646b13

Definite windows fix.

46ecddd

Prettyfying output.

4e8c330

Prettified the install process.

180e583

Fixing some issues that got lost with all installs / deletes.

8c165fc

First end-to-end working version (at least for VVV)

a9fcd6a

Added email because we want the new manifest to have all fields as th…

45ff8f5

…e old one.

Added a create databse function.

e9d3f16

Minor styling changes.

bd73c82

dingo-d reviewed Sep 23, 2018

View reviewed changes

Ivan Grginov added 4 commits November 30, 2018 15:46

Added VSCode phpcs setup instructions to README.

71229ab

Added NPM badge to github.

7b5c4a3

Added import / export to README.

b995c53

Added readme.txt

0d56d32

dingo-d reviewed Dec 5, 2018

View reviewed changes

Ivan Grginov added 9 commits December 6, 2018 09:21

Changed the readme as per feedback.

709d271

Infinum -> Eightshift, also added myself as contact.

ed40274

Valid NPM version.

1971768

Fixing browserlist.

a711625

Added setup gif.

b8214fe

Added emojis.

ffcb327

Fixed NPM badge styling.

f581dbb

Small README fixes.

e6b76bb

Removed lines because they look icky on github.

5a8cf1a

Better linting aliasing.

1d500fc

Ivan Grginov and others added 9 commits January 2, 2019 09:46

Fixing table of contents.

a70bb5d

Forgot an emoji for quick start.

610217f

Added logo try 1, probably won't look good because of the gray backgr…

689b89d

…ound.

Re-adding H1

a223bfd

New smaller padding logo.

3ecd3e9

Update travis file

876d077

Update header.php

2dd41d3

Fix override globals issue.

Lets not rename wp global variables.

dc93f13

Merge branch 'feature/zero-config-setup' of github.com:infinum/wp-boi…

5487cbd

…lerplate into feature/zero-config-setup

iruzevic approved these changes Jan 2, 2019

View reviewed changes

dingo-d merged commit 7ff6d94 into development Jan 2, 2019

iruzevic deleted the feature/zero-config-setup branch January 7, 2019 10:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/zero config setup #115

Feature/zero config setup #115

MetarDev commented Sep 21, 2018

dingo-d Sep 21, 2018

MetarDev Sep 21, 2018

dingo-d Sep 21, 2018

MetarDev commented Sep 23, 2018

dingo-d Sep 23, 2018

MetarDev Oct 4, 2018

dingo-d Sep 23, 2018

dingo-d Sep 23, 2018

MetarDev Oct 4, 2018

dingo-d Dec 5, 2018

MetarDev Dec 6, 2018

dingo-d Dec 5, 2018

MetarDev Dec 6, 2018

dingo-d commented Dec 27, 2018

MetarDev commented Dec 27, 2018

		@@ -12,6 +12,8 @@ This repository contains all the tools you need to start building a modern WordP

		First you need to install WordPress locally, using any of the local development environment you prefer. You can use XAMPP, MAMP, WAMP, VVV, Docker or Laravel Valet. You'll also need to have [Node.js](https://nodejs.org/en/), [Composer](https://getcomposer.org/) and [WP-CLI](https://wp-cli.org/) installed.

		Note regarding `Windows` - If you're installing this on `Windows` and you're using `XAMPP`, use `XAMPP` shell (Control Panel -> Shell) rather than `cmd`

		@@ -66,18 +68,18 @@ Once you're done with the above setup (no matter which method you used), run `np


		= Requirements =

		* PHP 7 or greater (recommended: PHP 7 or greater)

Feature/zero config setup #115

Feature/zero config setup #115

Conversation

MetarDev commented Sep 21, 2018

Currently done

To do

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MetarDev commented Sep 23, 2018

Changes in last push

To Do

Choose a reason for hiding this comment

Windows installation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dingo-d commented Dec 27, 2018

MetarDev commented Dec 27, 2018