Getting Started with a Project
Install Yeoman, Bower, Grunt CLI, and JSHint
npm install -g yo bower jshint grunt-cli
- Use a version lower than 2.5 (as of 1/10/2018)
Install Compass, SASS, and SCSS_Lint
sudo gem install compass sass scss_lint
Install the BREI-App Generator
npm install -g generator-brei-app
Finally, initiate the generator:
From here you will be presented with a series of options:
What would you like to do? (Use arrow keys) ❯ Create a New Project Create a Partial Create a Module Create a Template
Just follow the prompts and off you go!
- Do not stage the project (run npm install or other dependency managers) from Dropbox. The dependency folders, especially
node_modules, contain thousands of files and directories, and Dropbox can freeze the disk or cause permissions errors while it syncs.
All Sub-Generators install the properly formatted .hbs and .scss file according to BarkleyREI front-end coding standard conventions.
Note: you can either run
yo brei-app and select the desired sub generator task, or you can use the following commands to do it manually.
Create a new Project:
Create a new Template:
Create a new Module
Create a new Partial
Testing the Generator
This only needs run if you are locally modifying the generator files in this repo, not a project created with it.
npm install -g jshint
The test takes about 10-12 minutes to run.