Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.97 KB

README.md

File metadata and controls

75 lines (47 loc) · 2.97 KB
Raw

Hype Commerce

A hyper-fast, modern eCommerce platform

Installation

Hype Commerce is very easy to install for new developers. Simply follow the steps below to get started.

Requirements

  • node.js
  • MongoDB (at the moment, porting for a MySQL adapter)

Setup

# Clone the repo
git clone https://github.com/hypecommerce/hypecommerce.git hypecommerce

# Switch to our new folder
cd hypecommerce

# Install dependencies
npm install

# Run it!
npm start

Configuration

When you first start Hype Commerce, you will be prompted with an installation screen. Fill in your database credentials to continue with the installation process.

Documentation

You can find full documentation, code examples, support, and more on the official GitHub repository wiki page at https://github.com/hypecommerce/hypecommerce/wiki

Organization & Philosophy

We're shaping the next-generation of eCommerce. We made Hype Commerce to be scalable, adaptable, and affordable for any business to get up and running.

https://github.com/hypecommerce/hypecommerce/wiki/Philosophy

Contributing

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a "beginner friendly" tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  2. Fork the hypecommerce repository on Github to start making your changes.
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to CONTRIBUTORS.md

https://github.com/hypecommerce/hypecommerce/wiki/Pull-Requests-and-Contributions

Feedback

Join our Google Group for discussions, questions, and announcements from the people who are building Hype Commerce. We welcome everyone to join the discussion!

https://groups.google.com/forum/#!forum/hype-commerce

License

Hype Commerce | A hyper-fast, modern eCommerce platform
Copyright (C) 2014 Hype Commerce, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.