About MSUXF - MakingSense/MSUXF GitHub Wiki

[WIP]

Making Sense User Experience Framework (MSUXF from now on) are the basic structures and tools upon which we'll be building every new project.

There is no specific code, and should never be.

File Structure

MSUIF

assets // The only folder you should edit, since /dev and /dist are built on compiling
- icons // Drop the icons here to genereate de iconfont
- img // Drop the images here
- styles
  - core // Base styles
    - _base.scss
    - _settings.scss
    - _typography.scss
  - helpers // Basic tooling is defined here, such as mixins, functions, etc.
    - _animations.scss
    - _classes.scss
    - _functions.scss
    - _mixins.scss
  - libs // Bower dependencies are copied here
    - iconfont
    - jeet
    - normalize
  - modules // Reusable components
    - forms
      - _radio-checkbox.scss
    - _accordions.scss
    - _buttons.scss
    - _forms.scss
    - _hideable.scss
    - _icons.scss
    - _lists.scss
    - _modals.scss
    - _notifications.scss
    - _ratings.scss
    - _tables.scss
    - _tabs.scss
    - _tooltips.scss
  - templates // Template-specific styles use Sass's partial files.
    - _footer.scss
    - _header.scss
    - _home.scss
  - _shame.scss
  - styles.scss
- templates // For HTML files
  - index.html
dev // Result of the compilation will be dropped here
- css
  - styles.css
  - styles.css.map
- js
  - vendor
- index.html
dist // Result of the dist compilation will be dropped here
- css
  - styles.css
  - styles.css.map
- js
  - app.js // All the content from the Js folder will be concatenated and minified
- index.html
documentation // Sassdoc task will be executed on first run
- assets
- index.html
bower.json // UI dependencies defined here
gulpfile.js // Gulp tasks are defined here
package.json // Node dependecies such as grunt, postCSS plugins, etc. (remove taskrunner dependencies if unneeded)
README.md // Readme file