Skip to content

Commit 820dc16

Browse files
NaktibaldaNaktibalda
committed
[Docs] Add module installation instructions
1 parent 78afbc6 commit 820dc16

25 files changed

+550
-0
lines changed

‎docs/modules/AMQP.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: AMQP - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-amqp/tree/master/src/Codeception/Module/AMQP.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/AMQP.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/AMQP.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/AMQP.md">1.8</a></div>
99

1010
# AMQP
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-amqp
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `AMQP` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
This module interacts with message broker software that implements

‎docs/modules/Apc.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Apc - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-apc/tree/master/src/Codeception/Module/Apc.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Apc.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Apc.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Apc.md">1.8</a></div>
99

1010
# Apc
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-apc
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Apc` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
This module interacts with the [Alternative PHP Cache (APC)](http://php.net/manual/en/intro.apcu.php)

‎docs/modules/Asserts.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Asserts - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-asserts/tree/master/src/Codeception/Module/Asserts.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Asserts.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Asserts.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Asserts.md">1.8</a></div>
99

1010
# Asserts
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-asserts
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Asserts` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
Special module for using asserts in your tests.

‎docs/modules/Cli.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Cli - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-cli/tree/master/src/Codeception/Module/Cli.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Cli.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Cli.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Cli.md">1.8</a></div>
99

1010
# Cli
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-cli
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Cli` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
Wrapper for basic shell commands and shell output

‎docs/modules/DataFactory.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: DataFactory - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-datafactory/tree/master/src/Codeception/Module/DataFactory.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/DataFactory.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/DataFactory.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/DataFactory.md">1.8</a></div>
99

1010
# DataFactory
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-datafactory
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `DataFactory` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
DataFactory allows you to easily generate and create test data using [**FactoryMuffin**](https://github.com/thephpleague/factory-muffin).

‎docs/modules/Db.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Db - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-db/tree/master/src/Codeception/Module/Db.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Db.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Db.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Db.md">1.8</a></div>
99

1010
# Db
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-db
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Db` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
Access a database.

‎docs/modules/Doctrine2.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Doctrine2 - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-doctrine2/tree/master/src/Codeception/Module/Doctrine2.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Doctrine2.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Doctrine2.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Doctrine2.md">1.8</a></div>
99

1010
# Doctrine2
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-doctrine2
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Doctrine2` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
Access the database using [Doctrine2 ORM](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/).

‎docs/modules/FTP.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: FTP - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-ftp/tree/master/src/Codeception/Module/FTP.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/FTP.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/FTP.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/FTP.md">1.8</a></div>
99

1010
# FTP
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-ftp
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `FTP` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335

‎docs/modules/Filesystem.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Filesystem - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-filesystem/tree/master/src/Codeception/Module/Filesystem.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Filesystem.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Filesystem.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Filesystem.md">1.8</a></div>
99

1010
# Filesystem
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-filesystem
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Filesystem` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335
Module for testing local filesystem.

‎docs/modules/Laravel5.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ title: Laravel5 - Codeception - Documentation
88
<div class="btn-group" role="group" style="float: right" aria-label="..."><a class="btn btn-default" href="https://github.com/Codeception/module-laravel5/tree/master/src/Codeception/Module/Laravel5.php"><strong>source</strong></a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/3.1/docs/modules/Laravel5.md">3.1</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/2.5/docs/modules/Laravel5.md">2.5</a><a class="btn btn-default" href="https://github.com/Codeception/Codeception/blob/1.8/docs/modules/Laravel5.md">1.8</a></div>
99

1010
# Laravel5
11+
### Installation
12+
13+
If you use Codeception installed using composer, install this module with the following command:
14+
15+
{% highlight yaml %}
16+
composer require --dev codeception/codeception/module-laravel5
17+
18+
{% endhighlight %}
19+
20+
Alternatively, you can enable `Laravel5` module in suite configuration file and run
21+
22+
{% highlight yaml %}
23+
codecept init upgrade4
24+
25+
{% endhighlight %}
26+
27+
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
28+
Some modules are bundled with PHAR files.
29+
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
30+
31+
### Description
32+
1133

1234

1335

0 commit comments

Comments
 (0)