Clone this project from the latest commit (you don't want to get the entire history of this repo).
git clone --depth 1 <repo-url> <project-name>
cd <project-name>
Create and update the base config file according to your project's settings.
cp config.json.example config.json
open -e config.json
Install dependencies.
npm install
All source files are located inside the src
folder. The contents are mostly HTML5 Boilerplate files, with the exception of the CSS, which has been replaced with Sass from ZURB Foundation.
The default command. Runs the project and starts a BrowserSync server to watch and auto-reload your files.
grunt
Install with npm
, then include it inside Gruntfile.js
.
var libraries = {
js: [
'node_modules/foundation-sites/dist/js/foundation.min.js'
],
css: [
'node_modules/foundation-sites/scss'
]
};
JS files is automatically included in the build. CSS or Sass files is now in your path and ready to be imported.
@import 'foundation';
Create and update the FTP credential file. See here to understand the format.
cp .ftppass.example .ftppass
open -e .ftppass
Then, run this command.
grunt deploy --env=<environment>
Note: the environment
value must match with one of the keys in the .ftppass
file.
- Linters (ESLint, Stylelint, etc)
- ...