Giter Site home page Giter Site logo

storefront-twbs's Introduction

storefront-twbs

npm version license mit

Generate Bootstrap 4 custom theme for E-Com Plus storefront.

Small guide for partners, please take a look before creating new templates and widgets.

Compiling the storefront theme

From CLI, compile the custom SASS theme to new storefront Bootstrap kit and utilities passing directories and brand colors RGBs (without #):

npm i -g @ecomplus/storefront-twbs
storefront-twbs ~/mytheme/scss ~/mytheme/dist 6f42c1 e83e8c

Note that ~/mytheme/scss directory must contain theme folder with at least _variables.scss and _components.scss files.

Creating custom theme

Clone the GitHub repository and install dependencies with NPM:

git clone https://github.com/ecomclub/storefront-twbs
cd storefront-twbs
npm i

Edit the SASS files in the scss/theme directory, we recommend start from _variables.scss.

Start the localhost test server with:

npm run test

Or optionally just compile the SASS to CSS with:

npm run build

When you're done, generate sourcemap and minified CSS on dist folder by running:

npm run dist

Components

We're including all Bootstrap 4.3 components, for complete theme customizations, components styles may be overridden one by one on theme/_components.scss.

For partners

Note that your dist is not ready for stores, we also have to compile with the brand colors defined by the desired merchant.

The customized SASS files on theme folder will be used to compile the theme for each store with respective brand colors, so these are the files that you should put on your template source distributed in the Market.

Reference

tl;dr

You can also find open source Bootstrap 4 themes on Bootswatch ๐Ÿ˜‰.

storefront-twbs's People

Contributors

leomp12 avatar vitorrgg avatar

Watchers

James Cloos avatar  avatar

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.