This boilerplate runs on Gulp and Bower, which depend on Node and npm. Ensure that you have Node and npm installed before you begin. Additionally, this project utilizes the following packages:
- Install Bower globally using npm:
npm install -g bower - Install project dependencies with:
bower install. - For more details, visit Bower's website.
- Change to the project's root directory.
- Install the CLI by running:
npm install --global gulp-cli - Run Gulp with:
gulp. - For more details, visit Gulp's website.
All pages can be found under src > template > pages which use the default layout template found under src > template > layouts > default.njk.
You can also find all partials under src > template > partials > *.njk.
All CSS dependencies are imported at src > css > main.scss.
All JS files are part of the scriptFiles array in the gulpfile.js.
When working locally, running the local build command gulp will start a local server of the site and will automatically open your browser. Whenever changes are saved, the site will automaticaly regenerate your files and update your browser.
Note: If you're using Visual Studio Code, running cmd+shift+b will run the command in your editor without having to open the terminal. When you are done and want to stop the task, run cmd+shift+p and type task terminate to stop the task.
Running gulp production will build and compress your pages for production.