Skip to content

Commit c8f2b32

Browse files
authored
Merge pull request #353 from dotkernel/alexmerlin-patch-1
Update README.md
2 parents 1213756 + 490b8d4 commit c8f2b32

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ composer install
4747

4848
### Development mode
4949

50+
> **Do not enable development mode in production!**
51+
5052
If you're installing the project for development, you should **enable** development mode, by running:
5153

5254
```shell
@@ -88,13 +90,13 @@ php ./bin/doctrine-migrations migrate
8890

8991
This command will prompt you to confirm that you want to run it:
9092

91-
> WARNING! You are about to execute a migration in database "_<database-name>_" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
93+
> WARNING! You are about to execute a migration in database "`<database>`" that could result in schema changes and data loss. Are you sure you wish to continue? (yes/no) [yes]:
9294
9395
Hit `Enter` to confirm the operation.
9496

9597
#### Executing fixtures
9698

97-
> Fixtures are used to seed the database with initial values and must be executed after migrating the database.
99+
Fixtures are used to seed the database with initial values and must be executed after migrating the database.
98100

99101
To list all the fixtures, run:
100102

@@ -132,7 +134,7 @@ You can download/update all GeoLite2 databases at once, by running the following
132134
php ./bin/cli.php geoip:synchronize
133135
```
134136

135-
The output should be similar to the below, displaying per row:
137+
The output should be similar to the below:
136138

137139
```shell
138140
asn: n/a -> 2015-10-21 04:29:00
@@ -169,7 +171,7 @@ npm install
169171
If the above command fails, it could be caused by user permissions of `npm`.
170172
Recommendation is to install npm through `Node Version Manager`.
171173

172-
The watch command looks for JavaScript/CSS file changes and recompiles the assets under the public assets:
174+
The **watch** command looks for JavaScript/CSS file changes and recompiles the assets under the public assets:
173175

174176
```shell
175177
npm run watch
@@ -183,32 +185,30 @@ npm run prod
183185

184186
### Test the installation
185187

186-
> **Do not enable dev mode in production**
187-
188-
- Run the following command in your project's directory to start PHPs built-in server:
188+
Run the following command in your project's directory to start PHPs built-in server:
189189

190190
```shell
191191
php -S 0.0.0.0:8080 -t public
192192
```
193193

194-
> Running command `composer serve` will do the same thing, but the server might get closed after a couple of minutes.
194+
> Running command `composer serve` will do the same thing, but the server will time out after a couple of minutes.
195195
196-
> If you are still getting exceptions or errors regarding some missing services, try running the following command:
196+
If you are still getting exceptions or errors regarding some missing services, try running the following command:
197197

198198
```shell
199199
php ./bin/clear-config-cache.php
200200
```
201201

202-
- Open a web browser and visit `http://localhost:8080/`
202+
Open a web browser and visit `http://localhost:8080/`.
203203

204204
You should see the **Dotkernel Admin** login page.
205205
If you ran the migrations you will have an admin user in the database with the following credentials:
206206

207-
- **User**: `admin`
207+
- **Identity**: `admin`
208208
- **Password**: `dotadmin`
209209

210210
> **Production only**: Make sure you modify the default admin credentials.
211-
>
211+
212212
> **Development only**: `session.cookie_secure` does not work locally so make sure you modify your `local.php`, as per the following:
213213
214214
```php
@@ -219,4 +219,4 @@ If you ran the migrations you will have an admin user in the database with the f
219219
];
220220
```
221221

222-
> Do not change this in `local.php.dist` as well because this value should remain `true` on production.
222+
> Do not change this in `local.php.dist` as well because this value must remain `true` on production.

0 commit comments

Comments
 (0)