Code Monkey home page Code Monkey logo

vsf-capybara's Introduction

Capybara - Storefront UI based theme for Vue Storefront

New default template theme for Vue Storefront, based on Storefront UI. 90% of the Capybara code is closed in the Storefront UI library. Thanks to it, Capybara can maintain its flexibility, but minimize the risk of errors.

🔨 Current status: Production Ready

We have prepared short introduction to our coding standards and conventions we are using in Capybara theme.

🚀 See it in action

B2C Theme demo Try out our open demo and if you like it first give us some star on Github ★ and then contact us on Vue Storefront Official Slack or via [email protected].

This demo site is connected to Magento2.

📺 Video demo

See video demo!

✨ Features

Capybara theme provides out of the box ready to use elements, like Cart, Checkout, Modals or Product-related components - to name only a few of them, which all are based on awesome Storefront UI. It provides new look & feel for the Vue Storefront with simpler development experience. You can just grab it and use it, or you can play around to re-design existing components and build something new easily.

If you're new and need some guidance feel free to visit out forum or reach anyone from the core team on our slack:

🤝 Contributing

We are currently in the early developer’s preview phase. If you would like to help us improve this beautiful theme we'd be more than happy if you want to contribute! Here you can find all the required information how to start.

🔌 Installation

To be able to use new Capybara theme in your Vue Storefront installation, you need to:

  1. Install lerna globally:

    npm install -g lerna
    

    or

    yarn global add lerna
    
  2. Configure vsf-capybara repository as a git submodule in theme path of your Vue Storefront workspace, and then track master branch:

    git submodule add -b master https://github.com/DivanteLtd/vsf-capybara.git src/themes/capybara
    
  3. Fetch all the data:

    git submodule update --init --remote
    
  4. Generate local.json file from script generate-local-config.js:

    node src/themes/vsf-capybara/scripts/generate-local-config.js
    
  5. Update Vue Storefront configuration by copying local.json file from vsf-capybara to root config directory.

  6. Update TypeScript compiler option in tsconfig.json in root directory: change value for compilerOptions.paths.theme/* from default theme ["src/themes/default/*"] to brand new Capybara theme: ["src/themes/capybara/*"].

  7. Download all dependencies and start development server:

    lerna bootstrap && yarn dev
    
  8. That’s all! Now after opening your development server (http://localhost:3000 by default) you should see Vue Storefront with Capybara theme! 🎉

vsf-capybara's People

Contributors

qiqqq avatar pkarw avatar rakowskiprzemyslaw avatar psmyrek avatar dixitdeepak avatar iamwade avatar mohammad-k8 avatar dimasch avatar tom-aniol avatar

Watchers

 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.