marzeelabs / besugo

Boilerplate for MZ version of hugo + netlifyCMS
https://besugo.marzeelabs.org
10 stars 0 forks source link

Feature/#7 yarn no gulp #26

Closed Quicksaver closed 6 years ago

Quicksaver commented 6 years ago

Important notes from the readme!

Requirements

  1. hugo, install using homebrew if you don't have it already: brew install hugo
  2. yarn, you'll probably want to install with brew install yarn --without-node as to not override your system's Node.js or if you use nvm to manage node versions.

Install and Run

  1. Clone project locally
  2. If upgrading an existing project from npm, or whenever you need to rebuild dependencies, run yarn rebuild (shortcut to rm -rf node_modules & yarn install that I wrote to myself and left in); otherwise grab dependencies normally with yarn install;
  3. It's recommended to change the default port in package.json, to avoid having to worry about other Besugo projects being served on the same port.
  4. yarn start task serves the site locally and starts listening for changes

Changes

Use yarn

Removed everything-gulp

Moved src CMS config.yml file to another location

Changed some files and directory structure

Ignore intermediate files

Dev server port

Extra configurations in package.json

Other notes

Related but non-critical tickets

Obsoletes

pvhee commented 6 years ago

@Quicksaver great work on this refactoring. This makes everything quite a lot simpler and in line with what most web projects currently use: i.e. yarn / webpack / node scripts