Skip to content

Latest commit

 

History

History
75 lines (61 loc) · 2.12 KB

README.md

File metadata and controls

75 lines (61 loc) · 2.12 KB
Raw

The repository for the ultimate-huskies website.

Development

This wordpress site uses a modern stack to make development easy and maintainable. So make sure you have the required tools installed. The used file structure is based on Bedrock to enable Composer for wordpress. Its also using Timber to make use of TWIG as templating engine.

Requirements

Install

  • clone this repo https://github.com/Ultimate-Huskies/website.git
  • install php dependencies composer install
    • it installs the last wordpress version
    • it also installs all required wordpress plugins
  • create environment file to fill in the required parameters to connect to your database cp .env.example .env
  • point your server to [path_to_this_repo]/web
  • install theme dependencies npm install
    • it installs libs to convert less and coffeescript

Available build scripts

Run to (auto)compile changed coffeescript and less files.

Watch changes for theme files

npm run watch

One time compile all theme files

nom run build

One time compile all coffeescript files

nom run build:scripts

One time compile all less files

nom run build:styles

Installing new dependencies

For PHP

composer require <pkg>
composer update

For NodeJS

npm install <pkg> [--save|--save-dev]

For Frontend stuff using bower

./node_modules/.bin/bower install <pkg> [--save|--save-dev]

Contribution

  • Create new branch from master branch
  • Do your changes
  • Open PR against master
  • Squash merge with PR title following conventional commits

Deployment

  • Log into server and checkout master branch