Skip to content

Latest commit

 

History

History
168 lines (105 loc) · 9.01 KB

README.md

File metadata and controls

168 lines (105 loc) · 9.01 KB

About PrestaShop

Build Status Codacy Badge Gitter chat

PrestaShop is a free and Open Source e-commerce web application, committed to providing the best shopping cart experience for both merchants and customers. It is written in PHP, is highly customizable, supports all the major payment services, is translated in many languages and localized for many countries, has a fully responsive design (both front and back office), etc. See all the available features.

PrestaShop 1.7 back office

To download the latest stable public version of PrestaShop (currently, version 1.7), please go to the download page on the official PrestaShop site.

About the 'develop' branch

The 'develop' branch of this repository contains the source code for the latest version of PrestaShop 1.7.

PRESTASHOP 1.7 IS NOW PRODUCTION-READY! Its first stable version, 1.7.0.0, was released on November 7th, 2016. Further updates have been released since then. Learn more about it on the Build devblog.

You can click the "Download ZIP" button from the root of this repository to download the current state of PrestaShop 1.7.
If you prefer to download the regular 1.7 package, you can find the latest version on the the download page.

Also, the ZIP file does not contain the default modules. Since the 1.6 theme needs these module, the store will not display much as-is, even if you install the Starter Theme. We therefore advise you to focus your tests on the back office for the time being -- unless you are helping the team improve the Starter Theme.

Finally, the ZIP file contains resources for developers and designers that are not in the public archive, such as the unit testing files (in the /tests folder).

Server configuration

To install PrestaShop 1.7, you need a web server running PHP 5.6+ and any flavor of MySQL 5.0+ (MySQL, MariaDB, Percona Server, etc.).

You will also need a database administration tool, such as phpMyAdmin, in order to create a database for PrestaShop. We recommend the Apache or Nginx web servers (check out our example Nginx configuration file).

You can find more information on the System Administrator Guide.

If your host does not offer PHP 5 by default, you will find a few explanations about PHP 5 or the .htaccess file in our documentation, with details for certain hosting services.

Installation

Once the files in the PrestaShop archive have been decompressed and uploaded on your hosting space, go to the root of your PrestaShop directory with your web browser, and the PrestaShop unzipper/installer will start automatically. Follow the instructions until PrestaShop is installed.

If you get any PHP error, it might be that you do not have PHP 5 on your web server, or that you need to activate it. See this page for explanations about PHP 5, or contact your web host directly.
If you do not find any solution to start the installer, please post about your issue on the PrestaShop forums.

If you installed PrestaShop from GitHub:

composer install

Docker compose

This software can also be deployed with Docker and its tool Docker compose.

To run the software, use:

docker-compose up

Then reach your shop with the URL http://localhost:8001

It will bind your ports 8001 to the web server. If you want to use other ports, open and modify the file docker-compose.yml. MySQL credentials can also be found and modified in this file if needed.

Note: Before auto-installing PrestaShop, this container checks the file config/settings.inc.php does not exist on startup. If you expect the container to (re)install your shop, remove this file if it exists.

User documentation

The official PrestaShop 1.7 documentation is available online on its own website

First-time users will be particularly interested in the following guides:

  • Getting Started: How to install PrestaShop, and what you need to know.
  • User Guide: All there is to know to put PrestaShop to good use.
  • Updating Guide: Switching to the newest version is not trivial. Make sure you do it right.
  • Merchant's Guide: Tips and tricks for first-time online sellers.
  • The FAQ and the Troubleshooting pages should also be of tremendous help to you.

Contributing

PrestaShop is an Open Source project, and it wouldn't be possible without the help of the hundreds of contributors, who submitted improvements and bugfixes over the years. Thank you all!

If you want to contribute code to PrestaShop, read the CONTRIBUTING.md file in this repository or read the tutorials about contribution on the documentation site.

Current Travis status: Travis (The Unit Tests are being implemented, so the status might be broken).

If you want to help translate PrestaShop in your language, join us on Crowdin!

Current Crowdin status (for 69 registered languages): Crowdin

Reporting Issues

Our bugtracker is called the Forge. We encourage you to create detailed issues as soon as you see them.

See our Forge Guide with details and tips.

Reporting Security Issues

Responsible (and private) disclosure is a standard practice when someone encounters a security problem: before making it public, the discoverer informs the Core team about it, so that a fix can be prepared, and thus minimize the potential damage.

The PrestaShop team tries to be very proactive when preventing security problems. Even so, critical issues might surface without notice.

This is why we have set up the [email protected] email address: anyone can privately contact us with all the details about issues that affect the security of PrestaShop merchants or customers. Our security team will answer you, and discuss of a timeframe for your publication of the details.

Understanding a security issue means knowing how the attacker got in and hacked the site. If you have those details, then please do contact us privately about it (and please do not publish those details before we answered). If you do not know how the attacker got in, please ask for help on the support forums.

Extending PrestaShop

PrestaShop is a very extensible e-commerce platform, both through modules and themes. Developers can even override the default components and behaviors. Learn more about this using the Developer Guide and the Designer Guide.

Themes and modules can be obtained (and sold!) from PrestaShop Addons, the official marketplace for PrestaShop.

Community forums

You can discuss about e-commerce, help other merchants and get help, and contribute to improving PrestaShop together with the PrestaShop community on the PrestaShop forums.

Getting support

If you need help using PrestaShop 1.7, ask on the forums: https://www.prestashop.com/forums/forum/273-172x-current/

Thank you for downloading and using the PrestaShop Open Source e-commerce solution!