Skip to content

Commit

Permalink
Merge branch '1.0' into 1.1
Browse files Browse the repository at this point in the history
* 1.0:
  [Translations] Updated translations from Crowdin
  [Components] Fix links for documentation in readme
  Order update error fix
  Make readme shorter & more beautiful
  Remove badges from readme
  • Loading branch information
pamil committed Apr 23, 2018
2 parents a31ef96 + 3ef6623 commit 1f9e885
Show file tree
Hide file tree
Showing 20 changed files with 32 additions and 97 deletions.
91 changes: 13 additions & 78 deletions README.md
Expand Up @@ -2,25 +2,9 @@
<a href="http://sylius.com" target="_blank">
<img src="https://demo.sylius.com/assets/shop/img/logo.png" />
</a>
<br />
<a href="https://packagist.org/packages/sylius/sylius" title="License" target="_blank">
<img src="https://img.shields.io/packagist/l/Sylius/Sylius.svg" />
</a>
<a href="https://packagist.org/packages/sylius/sylius" title="Version" target="_blank">
<img src="https://img.shields.io/packagist/v/Sylius/Sylius.svg" />
</a>
<a href="http://travis-ci.org/Sylius/Sylius" title="Build status" target="_blank">
<img src="https://img.shields.io/travis/Sylius/Sylius/master.svg" />
</a>
<a href="https://scrutinizer-ci.com/g/Sylius/Sylius/" title="Scrutinizer" target="_blank">
<img src="https://img.shields.io/scrutinizer/g/Sylius/Sylius.svg" />
</a>
<a href="https://packagist.org/packages/sylius/sylius" title="Total Downloads" target="_blank">
<img src="https://poser.pugx.org/sylius/sylius/downloads" />
</a>
</h1>

Sylius is the first eCommerce framework for tailored solution based on [**Symfony**](http://symfony.com) and [**Doctrine**](http://doctrine-project.org).
Sylius is an Open Source eCommerce Framework on top of [**Symfony**](https://symfony.com).

The highest quality of code, strong testing culture, built-in Agile (BDD) workflow and exceptional flexibility make it the best solution for application tailored to your business requirements.
Powerful REST API allows for easy integrations and creating unique customer experience on any device.
Expand All @@ -29,81 +13,32 @@ We're using full-stack Behavior-Driven-Development, with [phpspec](http://phpspe

Enjoy being an eCommerce Developer again!

Documentation
-------------

Documentation is available at [docs.sylius.com](http://docs.sylius.com).

Requirements
------------

Read about the Sylius system requirements in detail [here](http://docs.sylius.com/en/latest/book/installation/requirements.html).

Installation
------------

You need [composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) to install PHP packages and [yarn](https://yarnpkg.com/lang/en/docs/install/) to install JS packages.

```bash
$ composer create-project sylius/sylius-standard my-sylius-shop && cd my-sylius-shop
$ php bin/console sylius:install
$ yarn install && yarn run gulp
$ php bin/console server:start
```

> Note: make sure to use PHP ^7.1. Using an older PHP version will result in installing an older version of Sylius.
Then open `http://localhost:8000/` in your web browser to enjoy your Sylius shop in a development environment.

Alternatively, you can use [Vagrant](http://docs.sylius.com/en/latest/book/installation/vagrant_installation.html) for your initial setup.
[Install Sylius](http://docs.sylius.com/en/1.0/book/installation/installation.html) with Composer (see [requirements details](http://docs.sylius.com/en/1.0/book/installation/requirements.html)).

**Production**
Alternatively, you can [use our Vagrant setup](http://docs.sylius.com/en/1.0/book/installation/vagrant_installation.html).

When you're ready to go live, setup your production database:

```bash
php bin/console sylius:install --env prod
```

And choose _N_ when it comes to the _Loading sample data_ step.

Then please refer to [Symfony's documentation](https://symfony.com/doc/current/setup/web_server_configuration.html) to properly setup your Apache/Nginx web server.


Troubleshooting
---------------
Documentation
-------------

Documentation is available at [docs.sylius.com](http://docs.sylius.com).

If something goes wrong, errors & exceptions are logged at the application level:
Community
---------

```bash
$ tail -f var/logs/prod.log
$ tail -f var/logs/dev.log
```
[Get Sylius support](http://docs.sylius.com/en/1.0/support/index.html) on [Slack](https://sylius.com/slack), [Forum](https://forum.sylius.com/) or [Stack Overflow](https://stackoverflow.com/questions/tagged/sylius).

If you are using the supplied Vagrant development environment, please see the related [Troubleshooting guide](http://github.com/Sylius/Vagrant/README.md#Troubleshooting) for more information.
Stay updated by following our [Twitter](https://twitter.com/Sylius) and [Facebook](https://www.facebook.com/SyliusEcommerce/).

Contributing
------------

Would like to help us and build the most developer-friendly eCommerce platform? Start from reading our [Contributing Guide](http://docs.sylius.com/en/latest/contributing/index.html)!

Stay Updated
------------

If you want to keep up with the updates, [follow the official Sylius account on Twitter](http://twitter.com/Sylius) and [like us on Facebook](https://www.facebook.com/SyliusEcommerce/).

Bug Tracking
------------

If you want to report a bug or suggest an idea, please use [GitHub issues](https://github.com/Sylius/Sylius/issues).

Community Support
-----------------

Have a question? Join our [Slack](http://sylius.com/slack) or post it on [StackOverflow](http://stackoverflow.com) tagged with ["sylius"](https://stackoverflow.com/questions/tagged/sylius).

MIT License
-----------
License
-------

Sylius is completely free and released under the [MIT License](https://github.com/Sylius/Sylius/blob/master/LICENSE).

Expand Down
Expand Up @@ -17,7 +17,7 @@ sylius:
apply_state_machine_transition_error: 'There was an unexpected problem with updating an order. Please, try to update order again.'
promotion_integrity: 'You are no longer eligible for this promotion %promotionName%.'
total_integrity: 'Your order total has been changed, check your order information and confirm it again.'
update_error: 'There was an unexpected problem with updating a product. Please, try to update product again.'
update_error: 'There was an unexpected problem with updating an order. Please, try to update order again.'
payment:
apply_state_machine_transition_error: 'There was an unexpected problem with updating a payment. Please, try to update payment again.'
product:
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Addressing/README.md
Expand Up @@ -20,7 +20,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Addressing/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Addressing/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Attribute/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Attribute/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Attribute/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Channel/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Channel/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Channel/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Currency/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Currency/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Currency/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Grid/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Grid/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Grid/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Inventory/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Inventory/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Inventory/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Locale/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Locale/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Locale/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Mailer/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Mailer/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Mailer/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Order/README.md
Expand Up @@ -17,7 +17,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Order/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Order/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Payment/README.md
Expand Up @@ -15,7 +15,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Payment/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Payment/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Product/README.md
Expand Up @@ -17,7 +17,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Product/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Product/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Promotion/README.md
Expand Up @@ -21,7 +21,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Promotion/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Promotion/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Registry/README.md
Expand Up @@ -11,7 +11,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Registry/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Registry/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Resource/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Resource/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Resource/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Shipping/README.md
Expand Up @@ -22,7 +22,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Shipping/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Shipping/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Taxation/README.md
Expand Up @@ -15,7 +15,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Taxation/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Taxation/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/Taxonomy/README.md
Expand Up @@ -34,7 +34,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/Taxonomy/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/Taxonomy/index.html).

Contributing
------------
Expand Down
2 changes: 1 addition & 1 deletion src/Sylius/Component/User/README.md
Expand Up @@ -13,7 +13,7 @@ Sylius is an Open Source eCommerce solution built from decoupled components with
Documentation
-------------

Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components/User/index.html).
Documentation is available on [**docs.sylius.com**](http://docs.sylius.com/en/latest/components_and_bundles/components/User/index.html).

Contributing
------------
Expand Down

0 comments on commit 1f9e885

Please sign in to comment.