You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-7Lines changed: 41 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@
8
8
9
9
## Introduction
10
10
11
-
This is a repository intended to serve as a starting point if you want to bootstrap a project in PHP.
11
+
This is a repository intended to serve as a starting point if you want to bootstrap a project in PHP. This repository has been explained in the [CodelyTV video "Introducción a PHP: Cómo configurar tu entorno de desarrollo 🐘" (Spanish)](https://www.youtube.com/watch?v=v2IjMrpZog4).
12
12
13
-
It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate, just run `composer create-project codelytv/php-bootstrap your-kata-name` and there you go:
14
-
* Latest versions of PHP and PHPUnit in order to practice with them
13
+
It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate, just run `composer create-project codelytv/php-bootstrap your-project-name` and there you go:
14
+
* Latest versions of PHP and PHPUnit
15
15
* Best practices applied:
16
16
*[`README.md`][link-readme] (badges included)
17
17
*[`LICENSE`][link-license]
@@ -25,13 +25,47 @@ It could be useful if you want to start from scratch a kata or a little exercise
25
25
26
26
## How To Start
27
27
28
+
You have 2 different alternatives: Using our [Packagist project](https://packagist.org/packages/codelytv/php-bootstrap) with Composer, or manually cloning [this repo](https://github.com/CodelyTV/php-bootstrap/):
29
+
30
+
### Using Composer
31
+
32
+
Start completely from scratch without having to delete this bootstrap project Git history:
33
+
28
34
1. If you don't have it already, [install Composer](https://getcomposer.org/download/).
29
-
2. Create your project based on this bootstrap repo: `composer create-project codelytv/php-bootstrap your-kata-name`.
30
-
3. Run all the checks: `composer test`. This will do some checks that you can perform with isolated commands:
35
+
2. Create your project based on the [Packagist project](https://packagist.org/packages/codelytv/php-bootstrap). This will also download the project dependencies: `composer create-project codelytv/php-bootstrap your-project-name`.
36
+
3. Move to the project directory: `cd your-project-name`
37
+
4. Run all the checks: `composer test`. This will do some checks that you can perform with isolated commands:
2.[PHP Style Check](https://github.com/squizlabs/PHP_CodeSniffer): `composer style`. If you want to fix style issues automatically: `composer fix-style`.
5. Upload your local commits to the new remote repo: `git push -u origin master`
47
+
6. Start coding!
48
+
49
+
### Cloning the repository
50
+
51
+
Just in case you prefer to avoid dealing with `composer create-project`, you can also clone this repository. We recommend to follow the next step by step process in order to avoid adding the bootstrap project commits to your project Git history:
52
+
53
+
1. Clone this repository: `git clone https://github.com/CodelyTV/php-bootstrap your-project-name`
54
+
2. Move to the project directory: `cd your-project-name`
55
+
3. If you don't have it already, [install Composer](https://getcomposer.org/download/).
56
+
4. Install the project dependencies: `composer install`
57
+
5. Run all the checks: `composer test`. This will do some checks that you can perform with isolated commands:
2.[PHP Style Check](https://github.com/squizlabs/PHP_CodeSniffer): `composer style`. If you want to fix style issues automatically: `composer fix-style`.
0 commit comments