Giter VIP home page Giter VIP logo

mbootstrap's Introduction

mavenecommerce

Magento-Bootstrap responsive theme

Magento-Bootstrap theme it is package fully based on Twitter Bootstrap 3 framework.

Assets

  • Bootstrap (SASS latest official version)
  • HTML5 support
  • Microdata support (schema.org)
  • Composer installer
  • Gulp js/css builder

Requirements

  1. Composer — Open https://getcomposer.org/doc/00-intro.md and install Composer to your system
  2. Node.js — Open http://nodejs.org and install latest Node.js version
  3. Gulp — Open http://gulpjs.com/ and install latest Gulp version

You can check if all of this installed by commands:

$ composer -V && node -v && gulp -v
Composer version 1.0-dev (d1a9cfbd634d3b9e3350a77189de9c6b20737111) 2015-07-02 09:36:31
v0.12.3
[16:35:34] CLI version 3.9.0
[16:35:34] Local version 3.9.0

Project_root/ folders hierarchy example:

$ tree -L 2
.
├── composer.json       -> composer.json file
├── composer.lock
├── magento             -> Magento CMS folder
│   ├── LICENSE.html
│   ├── ...
│   ├── gulpconfig.js   -> ../vendor/mavenecommerce/mbootstrap/gulpconfig.js
│   ├── gulpfile.js     -> ../vendor/mavenecommerce/mbootstrap/gulpfile.js
│   ├── ...
│   ├── node_modules    -> ../node_modules
│   ├── package.json    -> ../vendor/mavenecommerce/mbootstrap/package.json
│   ├── ...
│   └── var
├── node_modules        -> node_modules folder
└── vendor              -> installed composer modules

How to install

Step 1. Install theme as Composer module

Create (or edit) composer.json file in your project folder, near magento/ folder. You need add next lines to your composer.json:

"repositories": {
    "firegento": {
        "type": "composer",
        "url": "http://packages.firegento.com"
    },
    "mbootstrap": {
        "type": "vcs",
        "url": "[email protected]:mavenecommerce/mbootstrap.git"
    }
},
"require": {
    "magento-hackathon/magento-composer-installer": "*",
    "mavenecommerce/mbootstrap": "dev-master"
},
"extra": {
    "magento-root-dir": "magento"
}

You need add repository, require and path to your magento folder extra.magento-root-dir.

Or do it via commad line interface:

$ composer config repositories.firegento composer http://packages.firegento.com
$ composer config repositories.mbootstrap vcs [email protected]:mavenecommerce/mbootstrap.git
$ composer require magento-hackathon/magento-composer-installer:*
$ composer require mavenecommerce/mbootstrap:dev-master

So you will get something like that:

{
    "name": "mavenecommerce/mbootstrap-example",
    "description": "Mavenecommerce MBootstrap Theme Example",
    "minimum-stability": "stable",
    "license": "proprietary",
    "authors": [
        {
            "name": "Oleksii Filippovych",
            "email": "[email protected]",
            "role": "Developer"
        }
    ],
    "repositories": {
        "firegento": {
            "type": "composer",
            "url": "http://packages.firegento.com"
        },
        "mbootstrap": {
            "type": "vcs",
            "url": "[email protected]:mavenecommerce/mbootstrap.git"
        }
    },
    "require": {
        "magento-hackathon/magento-composer-installer": "*",
        "mavenecommerce/mbootstrap": "dev-master"
    },
    "extra": {
        "magento-root-dir": "magento"
    }
}

If you don't use command line and just edit composer.json than run $ composer install (if you run it in first time) or $ composer update --no-plugins for update your dependies.

Step 2.1 Prepare Gulp build environment

Go to your project folder and create project_folder/node_modules/ folder. You get:

.
├── composer.json
├── composer.lock
├── magento         — Magento folder
├── node_modules    - npm node_modules/ folder
└── vendor          - Composer modules

Then open magento/ folder and create symlink for node_modules/ folder by command

$ ln -s ../node_modules node_modules

If you are Windows user sorry but i don`t know how to help you with that :(

It is need for Gulp builder. After that just run $ npm install in your magento/ folder to install Gulp dependies. All Gulp dependies should be instaled to project_folder/node_modules/ folder, example:

.
├── composer.json
├── composer.lock
├── magento
│   ├── ...
│   ├── gulpconfig.js -> ../vendor/mavenecommerce/mbootstrap/gulpconfig.js
│   ├── gulpfile.js -> ../vendor/mavenecommerce/mbootstrap/gulpfile.js
│   ├── ...
│   ├── node_modules -> ../node_modules
│   ├── package.json -> ../vendor/mavenecommerce/mbootstrap/package.json
│   └── ...
├── node_modules
│   ├── del
│   ├── gulp
│   ├── gulp-autoprefixer
│   ├── gulp-bless
│   ├── gulp-cache
│   ├── gulp-concat
│   ├── gulp-imagemin
│   ├── gulp-load-plugins
│   ├── gulp-minify-css
│   ├── gulp-rename
│   ├── gulp-sass
│   ├── gulp-sourcemaps
│   ├── gulp-uglify
│   └── vinyl-paths
└── vendor

note: if you know how to make it easier share with us please :)

Step 2.2 Build MBootstrap theme resources (JS/CSS)

Go to project_folder/magento/ and run $ gulp:

$ gulp
[15:28:37] Using gulpfile /path_to_project_folder/vendor/mavenecommerce/mbootstrap/gulpfile.js
[15:28:37] Starting 'build-base-scripts'...
[15:28:38] Finished 'build-base-scripts' after 348 ms
[15:28:38] Starting 'build-base'...
[15:28:38] Finished 'build-base' after 17 μs
[15:28:38] Starting 'build-mbootstrap-scripts'...
[15:28:38] Finished 'build-mbootstrap-scripts' after 13 ms
[15:28:38] Starting 'build-mbootstrap-styles-clean'...
[15:28:38] Finished 'build-mbootstrap-styles-clean' after 1.36 ms
[15:28:38] Starting 'build-mbootstrap-styles'...
[15:28:39] Starting 'build-mbootstrap-images'...
[15:28:39] Finished 'build-mbootstrap-images' after 759 ms
[15:28:47] Finished 'build-mbootstrap-styles' after 9.31 s
[15:28:47] Starting 'build-mbootstrap-styles-ie9'...
[15:28:47] Finished 'build-mbootstrap-styles-ie9' after 129 ms
[15:28:47] Starting 'build-mbootstrap'...
[15:28:47] Finished 'build-mbootstrap' after 4.4 μs
[15:28:47] Starting 'build'...
[15:28:47] Finished 'build' after 2.82 μs
[15:28:47] Starting 'default'...
[15:28:47] Finished 'default' after 2.59 μs

This bulder will create JS/CSS theme files:

  • JS: builder will generate scripts into magento/js/build/ folder
  • CSS: builder will generate css-files into magento/skin/frontend/mbootstrap/default/build/css/ folder

Step 3. Update Magento configuration

Go to Admin Panel -> System -> Configuration -> Developer and open Template Settings Tab.

Set Allow Symlinks to Yes and Save.

Go to Admin Panel -> System -> Configuration -> Design and open Package Tab.

Set Current Package Name with mbootstrap value and Save. Open Theme Tab and check Default option value — it should be empty or default value and Save.

PS: rebuild cache if enable via Admin Panel -> System -> Cache Management. Select All and select Refresh or Disable action.

mbootstrap's People

Contributors

akorolyov avatar alexandrkorolev avatar klierik avatar leek avatar lykhouzov avatar rjocoleman avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mbootstrap's Issues

gulp returns error again

admin@localhost $ sudo gulp

[23:00:41] Using gulpfile /magento/.modman/mbootstrap/gulpfile.js
[23:00:41] Starting 'build-base-scripts'...
[23:00:41] Finished 'build-base-scripts' after 141 ms
[23:00:41] Starting 'build-base'...
[23:00:41] Finished 'build-base' after 6.22 μs
[23:00:41] Starting 'build-mbootstrap-scripts'...
[23:00:41] Finished 'build-mbootstrap-scripts' after 7.97 ms
[23:00:41] Starting 'build-mbootstrap-styles-clean'...
[23:00:41] Finished 'build-mbootstrap-styles-clean' after 867 μs
[23:00:41] Starting 'build-mbootstrap-styles'...
[23:00:41] Starting 'build-mbootstrap-images'...
[23:00:42] Finished 'build-mbootstrap-images' after 293 ms
[23:00:42] Starting 'build-mbootstrap-fonts'...
[23:00:42] Finished 'build-mbootstrap-fonts' after 802 μs
{ [Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss
2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables
Current dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/]
message: 'skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
column: 9,
line: 2,
file: '/magento/skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss',
status: 1,
messageFormatted: '\u001b[4mskin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\u001b[24m\n\u001b[90m 2:9\u001b[39m file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
name: 'Error',
stack: 'Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/\n at options.error (/usr/lib/node_modules/gulp-sass/node_modules/node-sass/lib/index.js:276:32)',
showStack: false,
showProperties: true,
plugin: 'gulp-sass' }
[23:00:42] Finished 'build-mbootstrap-styles' after 807 ms
[23:00:42] Starting 'build-mbootstrap-styles-ie9'...
[23:00:42] Finished 'build-mbootstrap-styles-ie9' after 53 ms
[23:00:42] Starting 'build-mbootstrap'...
[23:00:42] Finished 'build-mbootstrap' after 12 μs
[23:00:42] Starting 'build'...
[23:00:42] Finished 'build' after 5.83 μs
[23:00:42] Starting 'default'...
[23:00:42] Finished 'default' after 7.66 μs

gulp returns error

$ gulp

admin@localhost $ gulp
[16:18:44] Using gulpfile /magento/.modman/mbootstrap/gulpfile.js
[16:18:44] Starting 'build-base-scripts'...
[16:18:45] Finished 'build-base-scripts' after 150 ms
[16:18:45] Starting 'build-base'...
[16:18:45] Finished 'build-base' after 5.52 μs
[16:18:45] Starting 'build-mbootstrap-scripts'...
[16:18:45] Finished 'build-mbootstrap-scripts' after 7.81 ms
[16:18:45] Starting 'build-mbootstrap-styles-clean'...
[16:18:45] Finished 'build-mbootstrap-styles-clean' after 863 μs
[16:18:45] Starting 'build-mbootstrap-styles'...
[16:18:45] Starting 'build-mbootstrap-images'...
[16:18:45] Finished 'build-mbootstrap-images' after 305 ms
[16:18:45] Starting 'build-mbootstrap-fonts'...
[16:18:45] Finished 'build-mbootstrap-fonts' after 686 μs
{ [Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss
2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables
Current dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/]
message: 'skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
column: 9,
line: 2,
file: '/magento/skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss',
status: 1,
messageFormatted: '\u001b[4mskin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\u001b[24m\n\u001b[90m 2:9\u001b[39m file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
name: 'Error',
stack: 'Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/\n at options.error (/usr/lib/node_modules/gulp-sass/node_modules/node-sass/lib/index.js:276:32)',
showStack: false,
showProperties: true,
plugin: 'gulp-sass' }
[16:18:45] Finished 'build-mbootstrap-styles' after 821 ms
[16:18:45] Starting 'build-mbootstrap-styles-ie9'...
[16:18:46] Finished 'build-mbootstrap-styles-ie9' after 55 ms
[16:18:46] Starting 'build-mbootstrap'...
[16:18:46] Finished 'build-mbootstrap' after 12 μs
[16:18:46] Starting 'build'...
[16:18:46] Finished 'build' after 5.06 μs
[16:18:46] Starting 'default'...
[16:18:46] Finished 'default' after 8.07 μs

events.js:72
throw er; // Unhandled 'error' event
^
Error: EPERM, chmod '/magento/skin/frontend/mbootstrap/default/images/btn_window_close.gif'
[1] 29161 exit 8 gulp

$ gulp again:

admin@localhost $ gulp
[16:30:50] Using gulpfile /magento/.modman/mbootstrap/gulpfile.js
[16:30:50] Starting 'build-base-scripts'...
[16:30:50] Finished 'build-base-scripts' after 144 ms
[16:30:50] Starting 'build-base'...
[16:30:50] Finished 'build-base' after 5.85 μs
[16:30:50] Starting 'build-mbootstrap-scripts'...
[16:30:50] Finished 'build-mbootstrap-scripts' after 8.23 ms
[16:30:50] Starting 'build-mbootstrap-styles-clean'...
[16:30:50] Finished 'build-mbootstrap-styles-clean' after 861 μs
[16:30:50] Starting 'build-mbootstrap-styles'...
[16:30:50] Starting 'build-mbootstrap-images'...
[16:30:51] Finished 'build-mbootstrap-images' after 301 ms
[16:30:51] Starting 'build-mbootstrap-fonts'...
[16:30:51] Finished 'build-mbootstrap-fonts' after 864 μs
{ [Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss
2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables
Current dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/]
message: 'skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
column: 9,
line: 2,
file: '/magento/skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss',
status: 1,
messageFormatted: '\u001b[4mskin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\u001b[24m\n\u001b[90m 2:9\u001b[39m file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/',
name: 'Error',
stack: 'Error: skin/frontend/mbootstrap/default/scss/bootstrap/bootstrap.scss\n 2:9 file to import not found or unreadable: ../../../../../../../vendor/twbs/bootstrap-sass/assets/stylesheets/bootstrap/variables\nCurrent dir: /magento/skin/frontend/mbootstrap/default/scss/bootstrap/\n at options.error (/usr/lib/node_modules/gulp-sass/node_modules/node-sass/lib/index.js:276:32)',
showStack: false,
showProperties: true,
plugin: 'gulp-sass' }
[16:30:51] Finished 'build-mbootstrap-styles' after 817 ms
[16:30:51] Starting 'build-mbootstrap-styles-ie9'...
[16:30:51] Finished 'build-mbootstrap-styles-ie9' after 60 ms
[16:30:51] Starting 'build-mbootstrap'...
[16:30:51] Finished 'build-mbootstrap' after 7.17 μs
[16:30:51] Starting 'build'...
[16:30:51] Finished 'build' after 5.12 μs
[16:30:51] Starting 'default'...
[16:30:51] Finished 'default' after 7.5 μs

stream.js:94
throw er; // Unhandled stream error in pipe.
^
Error: EPERM, chmod '/magento/js/build/base/default/product_configurable.js'
[1] 2535 exit 8 gulp

Skin files missing when running "modman clone"

Error message when running "modman clone [REPO URL]":

WARNING: Target does not exist (.modman/mbootstrap/modman):
skin/frontend/bootstrap/default/bootstrap/bootstrap skin/frontend/bootstrap/default/bootstrap/bootstrap

Can be fixed by manually adding files from

skin/frontend/bootstrap/default/bootstrap/bootstrap

to .modman directory.

EDIT: it does break theme if files are not added

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.