Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Documentation / README] Simplified installation guide #8664

Merged
merged 1 commit into from
Sep 21, 2017
Merged

[Documentation / README] Simplified installation guide #8664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@
</p>

Sylius is the first eCommerce framework for tailored solution based on [**Symfony**](http://symfony.com) and [**Doctrine**](http://doctrine-project.org).
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.
Enjoy being an eCommerce Developer again!

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.

We're using full-stack Behavior-Driven-Development, with [phpspec](http://phpspec.net) and [Behat](http://behat.org)
We're using full-stack Behavior-Driven-Development, with [phpspec](http://phpspec.net) and [Behat](http://behat.org).

Enjoy being an eCommerce Developer again!

Documentation
-------------
Expand All @@ -37,20 +38,31 @@ Documentation is available at [docs.sylius.org](http://docs.sylius.org).
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
$ wget http://getcomposer.org/composer.phar
$ php composer.phar create-project sylius/sylius-standard project
$ cd project
$ composer create-project sylius/sylius-standard my-sylius-shop && cd my-sylius-shop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MySyliusShop?
Or even just acme?

$ php bin/console sylius:install
$ yarn install
$ yarn run gulp
$ yarn install && yarn run gulp
$ php bin/console server:start
$ open http://localhost:8000/
```

More information on installation can be found [in the documentation](http://docs.sylius.org/en/latest/book/installation/vagrant_installation.html).
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.org/en/latest/book/installation/vagrant_installation.html) for your initial setup.

**Production**

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.

To use Vagrant, see [this repository](http://github.com/Sylius/Vagrant) and [this guide](http://docs.sylius.org/en/latest/book/installation/installation.html).

Troubleshooting
---------------
Expand Down