Skip to content

Commit b52397e

Browse files
author
Marc Geurts
committed
Merge branch 'main' of https://github.com/MGeurts/genealogy
2 parents b0adc64 + 9dc642e commit b52397e

File tree

1 file changed

+49
-11
lines changed

1 file changed

+49
-11
lines changed

README.md

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,11 @@ To date, version 7 has not been fully implemented in any open-source php based p
296296
</ul>
297297

298298
Translations can be added by submitting a <b>Pull Request</b> to the project.<br />
299-
Translation integrity can be checked by issuing the command `php artisan translations:check --excludedDirectories=vendor`
299+
Translation integrity can be checked by issuing the command:
300+
301+
```bash
302+
php artisan translations:check --excludedDirectories=vendor
303+
```
300304

301305
Instructions on how to add a language can be found in <a href="https://github.com/MGeurts/genealogy/blob/main/README-LANGUAGES.md" target="_blank">README-LANGUAGES.md<br/>
302306

@@ -314,23 +318,45 @@ Both the <b>ancestors</b> and <b>descendants</b> family trees are build using <a
314318

315319
create a new project folder, cd into the folder
316320

317-
`git clone https://github.com/MGeurts/genealogy.git .`
321+
```bash
322+
git clone https://github.com/MGeurts/genealogy.git .
323+
```
318324

319-
`cp .env.example .env`
325+
```bash
326+
cp .env.example .env
327+
```
320328

321329
make the needed changes regarding name, url, database connection & mail server
322330

323-
`composer install`
331+
```bash
332+
composer install
333+
```
334+
335+
```bash
336+
php artisan key:generate
337+
```
338+
339+
```bash
340+
php artisan storage:link
341+
```
324342

325-
`php artisan key:generate`
343+
```bash
344+
php artisan migrate:fresh --seed
345+
```
326346

327-
`php artisan storage:link`
347+
```bash
348+
npm install && npm run build
349+
```
328350

329-
`php artisan migrate:fresh --seed`
351+
```bash
352+
php artisan serve
353+
```
330354

331-
`npm install & npm run build`
355+
or
332356

333-
`php artisan serve` or `npm run dev`
357+
```bash
358+
npm run dev
359+
```
334360

335361
## Updating
336362

@@ -344,14 +370,26 @@ Instructions on how to report security issues can be found in <a href="https://g
344370

345371
Testing is done using <a href="https://pestphp.com/">Pest</a>.<br/>
346372

347-
Command: `php artisan test` or `./vendor/bin/pest`<br/>
373+
Command:
374+
375+
```bash
376+
php artisan test
377+
```
378+
379+
or
380+
381+
```bash
382+
./vendor/bin/pest
383+
```
348384

349385
<b>Production (or local development) data</b> should be stored in a MySQL or MariaDB database configured in `.env`.<br /><br />
350386
<b>Testing data</b> should be stored in a separate MySQL or MariaDB database configured in `.env.testing` to avoid interfering with the production or development data.<br /><br />
351387

352388
Command to create the testing MySQL database:
353389

354-
`php artisan migrate --env=testing`
390+
```bash
391+
php artisan migrate --env=testing
392+
```
355393

356394
## Contributing
357395

0 commit comments

Comments
 (0)