Sylius

https://docs.sylius.com/public
Admin
Sylius is a headless, open-source eCommerce framework built on Symfony that gives development teams...
Tokens:41,316
Snippets:329
Trust Score:10
Update:6 hours ago
Show doc for...
Tokens:
Raw
### Initialize Sylius Docker environment and open localhost

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Run `make init` to build and start the Docker containers for Sylius Standard. Then open `http://localhost/` in your browser. Requires Docker and make to be installed.

```bash
make init
open http://localhost/
```

--------------------------------

### Run the Sylius interactive installer

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Execute the interactive installer from the project root. It checks system requirements, sets up the database, optionally installs demo data, configures the shop, generates API tokens, and installs assets.

```bash
bin/console sylius:install
```

--------------------------------

### Build front-end with npm

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Install front-end dependencies and build assets using npm. This is required before running the Sylius installer.

```bash
npm install
npm run build
```

--------------------------------

### Query documentation with ask and goal parameters

Source: https://docs.sylius.com/public/getting-started/basic-configuration.md

Perform an HTTP GET request to the documentation URL with ask and goal query parameters. ask is the immediate question, goal is the user's ultimate objective. Use when the answer is not on the current page.

```http
GET https://docs.sylius.com/public/getting-started/basic-configuration.md?ask=<question>&goal=<user_goal>
```

--------------------------------

### Interactive rebase to squash commits

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Starts an interactive rebase to squash commits.

```bash
git rebase -i upstream/2.2
```

--------------------------------

### Build front-end with yarn

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Install front-end dependencies and build assets using yarn. This is an alternative to npm and is often preferred for its features like workspaces and offline caching.

```bash
yarn install
yarn build
```

--------------------------------

### Clone Sylius-Standard repository

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Use this command to clone the Sylius-Standard repository into a new project directory. Replace 'your_project_name' with your desired project name. This is the first step in the Docker installation process.

```bash
git clone git@github.com:Sylius/Sylius-Standard.git your_project_name
```

--------------------------------

### Create a new Sylius project with Composer

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Use the Sylius Standard template to create a new project in a directory named AcmeStore. This command downloads the latest Sylius Standard and installs its dependencies.

```bash
composer create-project sylius/sylius-standard AcmeStore
```

--------------------------------

### Query Sylius documentation with GitBook API

Source: https://docs.sylius.com/public/getting-started/before-you-begin.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' query parameters. 'ask' is the immediate question, 'goal' describes the user's ultimate objective. Use when the answer is not on the current page.

```http
GET https://docs.sylius.com/public/getting-started/before-you-begin.md?ask=<question>&goal=<user_goal>
```

--------------------------------

### Enter the project directory

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Navigate into the newly created AcmeStore directory before proceeding with further steps.

```bash
cd AcmeStore
```

--------------------------------

### Set Symfony 7.0 requirement

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Ensure Symfony 7.0 is installed by setting the extra.symfony.require config and updating dependencies. This prevents installing Symfony components in the wrong version.

```bash
composer config extra.symfony.require "^7.0"
composer update
```

--------------------------------

### HTTP GET request to query documentation

Source: https://docs.sylius.com/public/getting-started/first-product.md

Use this HTTP GET request to query the Sylius documentation. The 'ask' parameter is the immediate question, and 'goal' describes the user's ultimate objective. The response contains a direct answer and relevant excerpts.

```http
GET https://docs.sylius.com/public/getting-started/first-product.md?ask=<question>&goal=<user_goal>
```

--------------------------------

### Configure PostgreSQL database connection in .env.local

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Create a .env.local file with the PostgreSQL DATABASE_URL. Replace placeholders with your credentials, host, database name, and server version.

```sh
DATABASE_URL=pgsql://<username>:<password>@<host>/<your_database_name>_%kernel.environment%?serverVersion=<your_db_version>&charset=utf8
```

--------------------------------

### Configure MySQL database connection in .env.local

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Create a .env.local file with the MySQL DATABASE_URL. Replace placeholders with your credentials, host, database name, and server version.

```sh
DATABASE_URL=mysql://<username>:<password>@<host>/<your_database_name>_%kernel.environment%?serverVersion=<your_db_version>&charset=utf8
```
Tokens:
Raw