Revised Quick Start Guide

Daniel Winning 2025-04-24 13:06:51 +01:00
parent 24cdf5e3ab
commit ff02aa0652

@ -1,3 +1,74 @@
After [installation](Installation), you'll need to ensure that your **Docker Engine** is installed and running before running any # Quick Start Guide
`loom` commands. If you attempt to run any `loom` commands while your Docker Engine is turned off, you'll see an
error message. Ready to spin up your first PHP development environment with **Loom Spinner CLI**?
Follow these steps to get started quickly!
## 1. Prerequisites
Before you launch your environment, ensure you have:
- Installed [Loom Spinner CLI](Installation)
- Docker Engine running on your machine
If Docker is not running, `loom` commands will display an error.
## 2. Create or Choose Your PHP Project
Make sure you have a PHP project directory—or create a fresh one. You can use Loom Spinner in both existing and new projects.
```shell
cd /path/to/my-project
```
## 3. Start the Environment
To launch a local development environment for your project, use:
```shell
loom spin:up my-project .
```
- `my-project` is the name you'll use for this environment.
- `.` means "use the current directory as the project root".
Loom Spinner will set up Docker containers with PHP, Nginx, Node, SQLite, and more, based on your configuration and project needs.
## 4. Access Your Project
Once the containers are running:
- Your code inside the project directory is available inside the container at `/data/var/www`
- Your project's `public` directory will be served via Nginx at `http://localhost:<nginx-port>`
You can check which port is being used by running:
```shell
docker ps
```
or viewing Docker Desktop.
## 5. Manage Your Environment
- **Stop the environment:**
```shell
loom spin:stop my-project
```
- **Start it again:**
```shell
loom spin:start my-project
```
- **Destroy the environment:**
```shell
loom spin:down my-project
```
(This will remove the containers created for the environment, don't worry this won't )
## 6. Next Steps
Loom Spinner is highly configurable. You can customize your environment by passing options to the command or by adding
a `spinner.yaml` file to your project root. Check out the [Configuration](Configuration) page for details.
---
You're ready to go! If you get stuck, check the other sections in this documentation or reach out for support.
Happy spinning! 🧵