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.

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

Update install-in-development-mode-on-macos-and-linux.md #1995

Merged
merged 8 commits into from
Jul 18, 2023
Original file line number Diff line number Diff line change
Expand Up @@ -41,38 +41,37 @@ This document describes how to install Spryker in [Demo Mode](/docs/scos/dev/set
## Clone a Demo Shop and the Docker SDK

1. Open a terminal.
2. Create a folder for the project and navigate into it:
```bash
mkdir spryker-shop && cd spryker-shop
```

3. Clone *one* of the following Demo Shops:
2. Clone *one* of the following Demo Shops and navigate into its folder:

* B2C Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop
```

* B2B Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \
cd b2c-demo-shop
```

* B2C Marketplace Demo Shop

```shell
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace
```

* B2B Marketplace Demo Shop

```shell
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace & \
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

& -> &&

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

the same in other parts

cd b2b-demo-marketplace
```

5. Clone the Docker SDK:
3. Clone the Docker SDK:

```shell
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,58 +28,62 @@ Depending on the needed WSL version, follow one of the guides:

* [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html).

## Install Spryker in Demo mode on Windows
## Clone a Demo Shop and the Docker SDK

1. Open Ubuntu.
2. Open a terminal.
3. Create a new folder and navigate into it.
4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops):
4. Clone *one* of the [Demo Shops](/docs/scos/user/intro-to-spryker/intro-to-spryker.html#spryker-b2bb2c-demo-shops) and navigate into its folder:

* B2C Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop
```

* B2B Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \
cd b2c-demo-shop
```

5. Depending on the cloned Demo Shop, navigate into the cloned folder:
* B2C Marketplace Demo Shop

* B2C Demo Shop:

```bash
cd b2c-demo-shop
```shell
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace
```

* B2B Demo Shop:
* B2B Marketplace Demo Shop

```bash
cd b2b-demo-shop
```shell
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace & \
cd b2b-demo-marketplace
```

{% info_block warningBox "Verification" %}

Make sure that you are in the correct folder by running the `pwd` command.
Make sure that you are in the Demo Shop's folder by running the `pwd` command.

{% endinfo_block %}
{% endinfo_block %}

6. Clone the Docker SDK repository into the same folder:
5. Clone the Docker SDK repository into the same folder:

```shell
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
```

7. Add your user to the `docker` group:
## Configure and start the instance

1. Add your user to the `docker` group:

```bash
sudo usermod -aG docker $USER
```

8. Bootstrap the local Docker setup for demo:
2. Bootstrap the local Docker setup for demo:

```shell
docker/sdk bootstrap
Expand All @@ -91,7 +95,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan

{% endinfo_block %}

9. Update the `hosts` file:
3. Update the `hosts` file:
1. Open the Start menu.
2. In the search field, enter `Notepad`.
3. Right-click *Notepad* and select **Run as administrator**.
Expand All @@ -118,7 +122,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan
9. Select **File > Save**.
10. Close the file.

10. Build and start the instance:
4. Build and start the instance:

```shell
docker/sdk up
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,38 +47,37 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/
## Clone a Demo Shop and the Docker SDK

1. Open a terminal.
2. Create a folder for the project and navigate into it:
```bash
mkdir spryker-shop && cd spryker-shop
```

3. Clone *one* of the following Demo Shops:
2. Clone *one* of the following Demo Shops and navigate into its folder:

* B2C Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop
```

* B2B Demo Shop:

```shell
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \
cd b2c-demo-shop
```

* B2C Marketplace Demo Shop

```shell
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace
```

* B2B Marketplace Demo Shop

```shell
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace && \
cd b2b-demo-marketplace
```

5. Clone the Docker SDK:
3. Clone the Docker SDK:

```bash
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This document describes how to install Spryker in [Development Mode](/docs/scos/
* [Install Docker prerequisites on Windows with WSL2](/docs/scos/dev/set-up-spryker-locally/install-spryker/install-docker-prerequisites/install-docker-prerequisites-on-windows-with-wsl2.html).


## Install Spryker in Development mode on Windows
## Clone a Demo Shop and the Docker SDK

{% info_block warningBox "Filesystems" %}

Expand All @@ -49,43 +49,48 @@ Recommended: `/home/jdoe/workspace/project`.

* B2C Demo Shop:

```bash
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop
```shell
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202212.0-p2 --single-branch ./b2c-demo-shop && \
cd b2c-demo-shop
```

* B2B Demo Shop:

```bash
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop
```shell
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202212.0-p2 --single-branch ./b2b-demo-shop && \
cd b2c-demo-shop
```

5. Depending on the Demo Shop you've cloned, navigate into the cloned folder:

* B2C Demo Shop:
* B2C Marketplace Demo Shop

```bash
cd b2c-demo-shop
```shell
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2c-demo-marketplace && \
cd b2c-demo-marketplace
```

* B2B Demo Shop:
* B2B Marketplace Demo Shop

```bash
cd b2b-demo-shop
```shell
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202212.0-p2 --single-branch ./b2b-demo-marketplace & \
cd b2b-demo-marketplace
```

{% info_block warningBox "Verification" %}

Make sure that you are in the correct folder by running the `pwd` command.
Make sure that you are in the Demo Shop's folder by running the `pwd` command.

{% endinfo_block %}

6. Clone the Docker SDK:
5. Clone the Docker SDK:

```bash
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
```

7. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`:
## Configure and start the instance


1. In `{shop_name}/docker/context/php/debug/etc/php/debug.conf.d/69-xdebug.ini`, set `xdebug.remote_host` and `xdebug.client_host` to `host.docker.internal`:

```text
...
Expand All @@ -94,13 +99,13 @@ xdebug.remote_host=host.docker.internal
xdebug.client_host=host.docker.internal
```

8. Add your user to the `docker` group:
2. Add your user to the `docker` group:

```bash
sudo usermod -aG docker $USER
```

9. Bootstrap local docker setup:
3. Bootstrap local docker setup:

```bash
docker/sdk bootstrap deploy.dev.yml
Expand All @@ -112,7 +117,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan

{% endinfo_block %}

10. Update the hosts file based on the output of the previous step:
4. Update the hosts file based on the output of the previous step:
1. Open the Start menu.
2. In the search field, enter `Notepad`.
3. Right-click **Notepad** and select **Run as administrator**.
Expand All @@ -132,7 +137,7 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan
9. Click **File&nbsp;<span aria-label="and then">></span> Save**.
10. Close the file.

11. Build and start the instance:
5. Build and start the instance:

```bash
docker/sdk up
Expand Down