Skip to content

Latest commit

 

History

History
185 lines (135 loc) · 7.5 KB

README.md

File metadata and controls

185 lines (135 loc) · 7.5 KB
Raw

Pattern Library Boilerplate

How to use this repo as a boilerplate to start a new project

  1. Clone this repo with -o boilerplate which will name the initial remote boilerplate instead of origin:

    git clone -o boilerplate [email protected]:fewagency/boilerplate-pattern-library.git NEW_PROJECT_DIR

  2. cd into the new project directory

  3. Create a new empty git repo for your new project through your git service

    (If that's on github, keep the resulting page open in your browser - it has some nifty commands you'll want to copy and use below)

  4. Set up the new repo as a new remote with tracking (-u) in your local project:

    git remote add origin GIT_URL_FOR_EMPTY_REPO
git push -u origin master

    (These two lines can be copied from the page github displays after creating an empty repo)

  5. In the project directory, run composer update to use the latest dependencies.

  6. You may (optionally) delete the default branch for the boilerplate remote:

    git remote set-head boilerplate -d

    (Removing the boilerplate/HEAD pointer from boilerplate/master means you will need to push specifically to boilerplate/master instead of just boilerplate should you want to update something back into the original boilerplate repo from your new project)

  7. Remove this section from docs & change the headline

    • TODO: Update the headline in this README to something suitable for your new project!
    • TODO: Remove this section about using the boilerplate from this README as it won't be relevant when your new project no longer represents a boilerplate repo!

About boilerplate repo usage

This method for installing boilerplate packages is inspired by http://stackoverflow.com/questions/4096448/git-workflow-using-one-repo-as-the-basis-for-another

Another method could be http://www.tekkie.ro/methodology/use-git-checkout-index-initialise-project-from-boilerplate-repository/

Other ways to do it is to just get a zip file of this repo from github and start from that, or clone this repo and then recursively remove all .git folders.

Development installation

  1. Clone the git-repository into a directory of your choice

  2. In the project directory, run composer create-project to bootstrap and install composer dependencies

    (If composer ever chokes at your PHP-version, try adding --ignore-platform-reqs)

Building assets

We're using Laravel Mix for assets, so run npm install in the project directory and then npm run dev or npm run watch will build the assets during development.

Deploy

  1. Install all dependencies for the build in the build environment:

    # refresh: .nvmrc, package.json, composer.json, composer.lock
# The refresh-comment above defines the file changes to trigger this section for Deploybot 

# Make sure the node version specified in the .nvmrc file is used
nvm install
nvm use

# Install node_modules
npm install

# Update composer and install composer dependencies for production
/usr/local/bin/composer self-update
composer install --no-dev --no-interactions

    (This goes in the Advanced options - Cached build commands section in Deploybot)

  2. Build assets for production:

    # Make sure the node version specified in the .nvmrc file is used
nvm use

# Build assets for production
npm run production

    (This goes in the Compile, compress, or minimize your code section in Deploybot)

  3. The node_modules directory may be excluded from actual deploy after the build has finished

    (This goes in the Exclude certain paths from being uploaded section in Deploybot)

When the build fails...

If the build server complains about not having unzip, add this before the composer install:

# Make sure unzip is available
apt-get install unzip

If npm fails with certificate errors, try (temporarily) adding npm config set strict-ssl false before npm install.

Pattern library

The pattern/component library is built using macropiche and can be browsed at /pattern-library/ under the public folder.

Installing a CMS or framework on top of this boilerplate

If your framework has it's own handling of .env, just remove the fewagency/env requirement from composer.json!

WordPress - with Multisite

It's hard getting Multisite to work with WordPress subdirectory installs, therefore we've come up with a way of installing WordPress from download instead of using Composer. See issue #10 for background.

Installing WordPress

Adding this post-install-cmd script to composer.json will make composer install trigger a download of the specified WordPress version and install it straight into the /public/ folder - overwriting any previous WordPress files. To update WordPress, change the version number in the download script, and run composer install.

{
  "scripts": {
    "post-install-cmd": [
      "@install-wordpress"
    ],
    "install-wordpress": "curl -sS https://wordpress.org/wordpress-4.6.1.tar.gz | tar --strip-components=1 -xz -C public"
  }
}

Adding this to .gitignore will prevent the downloaded WordPress files to be checked into version control:

# Ignore the wordpress files except the wp-config
/public/wp-*
!/public/wp-config.php
/public/index.php
/public/xmlrpc.php
/public/license.txt
/public/readme.html

In public/wp-config.php you can use env() to read environment variables from .env by following the instructions for fewagency/env.

Configure WordPress with Multisite

After installing the WordPress files into the /public/ directory, follow the rest of the usual WordPress install guides:

Laravel

Laravel can be installed on top of the boilerplate by moving a fresh Laravel install from another directory into the project directory.

  1. Follow the Laravel instructions to install a fresh Laravel app into a new temporary directory.

  2. Prepare this original boilerplate repo by pushing any local changes to central repo (should something go wrong).

  3. Create a new branch from the original repo. Why not call it laravel-install?

  4. Merge the Laravel file structure from the temporary directory into this boilerplate project directory:

    rsync -av [PATH TO FRESH LARAVEL INSTALL]/ [PATH TO THIS BOILERPLATE DIRECTORY]/

  5. Manually review every file changed by the merge and make sure to bring back any modifications from the original repo that should not be overwritten. Commit merged files along the way.

  6. Run composer update after reviewing file composer.json.

  7. Run npm update after reviewing file package.json.

  8. Run npm run dev after reviewing file webpack.mix.js.

    If gulpfile.js is present, try to move config over to webpack.mix.js before deleting it.

  9. Delete file LocalValetDriver.php as the default Laravel Valet driver should take over.

  10. Move the pattern-library files entirely into resources/views and set up routes for them in routes/web.php.

  11. Delete the temporary fresh Laravel directory.