Giter Club home page Giter Club logo

corporify-ui-package's Introduction

Corporify-ui-package

Style UI package for corporify

Features

  • 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;

Requirements

Install

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.

Modular approach

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.

Development workflow overview

  • 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;

Adding packages

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 tasks

  • 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

Notice

The final release state is not deployed yet. It will include image processing, minification & other validations.

corporify-ui-package's People

Contributors

muffles avatar erikrferreira avatar tomastm avatar a31859 avatar

Watchers

Sergio Veiga avatar Tiago Alves avatar James Cloos avatar Simon avatar Andy Kellens avatar Hugo Rodrigues avatar Koen Betsens avatar Miguel Sousa avatar Ricardo Malta avatar  avatar marcelo.teixeira avatar  avatar Cátia Araújo avatar António Simões avatar  avatar Nuno Jorge avatar Gonçalo Santos avatar Bram Van Oost avatar Cláudio Alves avatar Erick Rettozi avatar Alvin avatar Maria Ribeiro avatar  avatar  avatar

corporify-ui-package's Issues

meta wraning

All core ui packages generate a small meta warning on bower dependency install:

bower corporify-ui-package#* invalid-meta corporify-ui-package is missing "main" entry in bower.json
bower corporify-ui-package#* invalid-meta corporify-ui-package is missing "ignore" entry in bower.json

readme typo & missing docu

Little typo:
More information on this design patter can be found here.

Missing:
Link to used icon set (or html overview of them. Unable to search)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.