Skip to content

Commit 067c15b

Browse files
committed
docs: improve Getting Started section with clearer sequential instructions
Restructures the installation and setup instructions in the README to present them in a logical, sequential order. This change prevents confusion by clearly indicating that containers must be started before project initialization. The new numbered format creates a step-by-step workflow that guides users through the entire process from starting the environment to accessing the application and finally stopping the services when done. Each step now includes more detailed explanations of what each command accomplishes, improving the overall user experience for newcomers.
1 parent f9d8b1e commit 067c15b

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,34 +36,47 @@ git clone https://github.com/nanoninja/docker-nginx-php-mysql.git
3636
cd docker-nginx-php-mysql
3737
```
3838

39-
### Initialize the project
39+
## 🏁 Getting Started
4040

41-
This command will set up everything you need to start development:
41+
Setting up your development environment involves just a few simple steps:
4242

43-
```bash
44-
make init
45-
```
46-
47-
## 🏁 Quick Start
43+
### 1. Start the Docker environment
4844

49-
### Start the environment
45+
First, start all the Docker containers required for the environment:
5046

5147
```bash
5248
# Start with default environment (development)
5349
make start
5450

55-
# Or explicitly select an environment
56-
make dev # For development
57-
make prod # For production
51+
# Or explicitly select an environment before starting
52+
make dev # For development mode
53+
make prod # For production mode
5854
```
5955

60-
### Access your application
56+
### 2. Initialize the project
57+
58+
After the containers are running, initialize the project to install dependencies and set up the environment:
59+
60+
```bash
61+
make init
62+
```
63+
64+
This command will:
65+
66+
- Copy the composer configuration template
67+
- Install PHP dependencies via Composer
68+
- Set up the appropriate file permissions
69+
- Prepare the environment for development
70+
71+
### 3. Access your application
72+
73+
Once the environment is running and initialized, you can access:
6174

6275
- Web: [http://localhost:8000](http://localhost:8000)
6376
- Secure Web: [https://localhost:3000](https://localhost:3000) (SSL certificates must be configured)
6477
- PHPMyAdmin: [http://localhost:8080](http://localhost:8080) (username: dev, password: dev)
6578

66-
### Stop the environment
79+
### 4. Stop the environment when finished
6780

6881
```bash
6982
make stop

0 commit comments

Comments
 (0)