Style UI package for corporify
- Gulp;
- Bower to manage dependencies;
- CSS pre-compile through SASS;
- JShint;
- SASS and JS minification and concatenation;
- Handlebars for template concatenation;
- Localhost server deploy;
- Synchronized browser testing;
- Atomic design system;
Install the dependencies with npm install
or sudo npm install
. Then just run bower install
and gulp
. If you don't have bower or gulp run npm install --global bower
, npm install --global gulp-cli
and npm install --save-dev gulp
before.
This UI boilerplate is based on atomic design methodology. The components are divided into Atoms, Molecules, Organisms & Pages, thus, using a modular development approach. More information on each component is found on their respective folders. There is also a global folder containing header & footer placeholders for your head & footer code, that will automatically be included on each page. More information on this design patter can be found here.
- Atoms will include the smaller components;
- Molecules are components that will include atom components;
- Organisms are bigger components that will include molecules & atoms;
- Pages are page templates that are built through the usage of all components put together. Will include the code from head.html & foot.html automatically
- head.html is the placeholder for all head scripts, links and any code that should be placed on top of an HTML template;
- foot.html is the placeholder for all the scripts that should be placed on the bottom of an HTML template;
The donderstarters are setup so you can easily add external packages to your project, while making it easier to manage dependencies. Doing
bower install <package-name>
will add the package to the src/vendor folder. You can browse for available bower packages through bower search page, and general documentation on bower in bower.io.
After adding the package, you need to include it into the build process (gulpfile.js:44) and into your foot.html file, making it available in every template page you make.
- gulp will build the files inside the /dist folder and perform a watch. You are ready to start developing
- gulp server will build the files inside the /dist folder and generate a localserver, among other functionalitites. More information on this feature can be found here
- gulp build will build the files inside the /dist folder. No watcher.
- gulp clean will clean the dist folder
The final release state is not deployed yet. It will include image processing, minification & other validations.