Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 6.03 KB

README.md

File metadata and controls

92 lines (61 loc) · 6.03 KB
Raw

The CS-Cart Boilerplate Theme

A CS-Cart theme based on HTML5 Twitter Bootstrap 3.3.5

The Boilerplate theme exists to simplify custom design development for CS-Cart. It uses Bootstrap 3.3.5, that provides pre-built reusable components such as dropdowns, navigation, buttons, and other interface elements. You get the building blocks and the example of how they can be put together to create a theme.

Boilerplate only has 1,000 lines of our CSS code left, as opposed to 11,000 lines in CS-Cart’s standard Responsive theme (and we aim to get rid of our CSS entirely). That way you don’t have to figure out our code: if you are familiar with Bootstrap, you can get started quickly.

We’re looking forward to your pull requests and issues with suggestions on how we can improve Boilerplate. Let’s work on it together, and eventually all of us will have to work less. Read our detailed blog post to learn about all the features of the new CS-Cart Boilerplate theme.

Table of contents

  • Installation
  • Bug Reporting and Feedback
  • Contributing
  • Copyright and License

Installation

There are two ways to install the Boilerplate theme: via Git and from downloaded ZIP archive.

Git

Follow these steps to install the Boilerplate theme from GitHub:

  1. Go to a CS-Cart folder via this bash command:
cd your-project/
  1. Clone the Boilerplate theme repository:
git clone https://github.com/cscart/cscart-boilerplate.git design/themes/boilerplate
  1. Go to the CS-Cart administration panel, and on the Design → Themes page select the CS-Cart Boilerplate theme.

ZIP Archive

  1. In the CS-Cart administration panel, go to the Design → Themes page
  2. Click the “+” button at the top right of the page
  3. Choose an option to upload the theme via URL and specify this URL: https://github.com/cscart/cscart-boilerplate/archive/master.zip
  4. Switch to the Browse all available themes tab, find the CS-Cart Boilerplate theme and install it.
  5. Switch back to Installed theme tab and Activate the CS-Cart Boilerplate theme

Bug Reporting and Feedback

Please test the new Boilerplate theme and tell us what you think about it in this forum topic. We greatly appreciate your feedback!

Help us polish this theme—report bugs if you find any.

Contributing

To contribute to Boilerplate, you need to know how to work with Git and GitHub:

  1. If you haven’t used Git before, check out this tutorial; you can also read Git documentation or find other tutorials on the Internet;
  2. If you want to learn more about GitHub, check out GitHub Help.

You’ll need a GitHub account to submit an issue or a pull request.

Submitting an Issue

Before you submit an issue, please run a search to see that it wasn’t submitted before. That way we’ll be able to deal with issues faster.

If the issue appears to be a bug, and it hasn’t been reported yet, open a new issue: switch to the Issues tab, press the New Issue button and fill in the form. You’ll need to be logged in to your GitHub account.

When submitting an issue, please provide the following information, so that we can fix it quickly:

Short summary of the issue - That helps us to keep things organized.

Why is it a problem for you? - Not all issues are bugs. If you have a suggestion on how to improve Boilerplate, please tell us how this improvement would benefit the theme.

Browsers and operating systems - If we know that the issue appears only in specific browsers or only in some operating systems, we’ll be able to reproduce it faster.

Steps to reproduce the issue - We need to see the issue for ourselves to confirm and fix it.

Suggest a fix - If you know what might be causing the bug, please let us know.

Submitting a Pull Request

GitHub allows you to make a full copy of the Boilerplate theme and work on it separately. Once you’ve made some changes, you can send us a pull request so that we can include your changes to the main repository.

To contribute to Boilerplate development, do this:

  1. Register an account at GitHub, if you haven’t done it yet—you’ll need the account to complete the following steps.
  2. Fork the Boilerplate theme—get your own copy of the main Boilerplate repository to work on and experiment with.
  3. Clone your fork to your local machine—a local repository is where all the work is done.
  4. Create a branch in your local clone—having separate branches for different tasks helps to keep things organized.
  5. Work on the Boilerplate theme in this branch. Please make sure to follow our coding standards
  6. Push your changed branch to your fork in your GitHub account—the changes you made locally will appear in your online repository.
  7. Create a pull request—submit your changes to us.

That’s it! Our specialists will review the changes and may pull them to the repository.

Copyright and License

Code released under the MIT license.