Skip to content

Commit 55cdfa5

Browse files
committed
docs: revise from-scratch guide to use starter template
1 parent b7ddb41 commit 55cdfa5

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

docs/getting-started/from-scratch.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,36 @@ Start a new Magento project with the devcontainer when you don't have an existin
44

55
## Prerequisites
66

7+
- [Git](https://git-scm.com/)
78
- [VS Code](https://code.visualstudio.com/) with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
89
- [Docker](https://www.docker.com/products/docker-desktop/)
910

1011
## Steps
1112

12-
1. Create a project directory and add the devcontainer:
13+
1. Clone the [starter project from GitHub](https://github.com/graycoreio/magento2-devcontainer-starter)
1314

1415
```bash
15-
mkdir my-magento-store && cd my-magento-store
16-
mkdir -p .devcontainer
17-
git submodule add https://github.com/graycoreio/magento2-devcontainer.git .devcontainer/magento2-devcontainer
16+
git clone git@github.com:graycoreio/magento2-devcontainer-starter.git
1817
```
1918

20-
2. Run the init script and select your desired Magento version:
19+
<details>
20+
<summary>Alternative: manual setup without the starter project</summary>
21+
22+
If you don't want to use the starter project, you can initialize your store manually (this assumes that you have a unix shell):
2123

2224
```bash
25+
mkdir my-magento-store && cd my-magento-store
26+
git init
27+
mkdir -p .devcontainer
28+
git submodule add https://github.com/graycoreio/magento2-devcontainer.git .devcontainer/magento2-devcontainer
2329
.devcontainer/magento2-devcontainer/bin/init.sh
2430
```
2531

26-
3. Open in VS Code and click **Reopen in Container** when prompted.
32+
</details>
33+
34+
2. Open in VS Code and click **Reopen in Container** when prompted.
2735

28-
4. Create the Magento project inside the container:
36+
3. Create the Magento project inside the container:
2937

3038
```bash
3139
composer create-project \
@@ -36,13 +44,13 @@ cp -r /tmp/magento/. /workspace/
3644
rm -rf /tmp/magento
3745
```
3846

39-
5. Run setup:
47+
4. Run setup:
4048

4149
```bash
4250
.devcontainer/magento2-devcontainer/bin/setup-install.sh | bash
4351
```
4452

45-
6. Verify the installation:
53+
5. Verify the installation:
4654

4755
```bash
4856
bin/magento --version

0 commit comments

Comments
 (0)