Skip to content

Commit fd6dfd2

Browse files
author
Samuel Akopyan
committed
~ changes in composer.json
1 parent b0f9bdf commit fd6dfd2

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,17 @@ It implements the the Model-View-Controller (MVC) design pattern and principles,
1515
and data layers. It provides an architecture, components and tools for developers to build a complex web applications
1616
faster and safer.
1717

18-
## Installation
18+
## Installing ApPHP Framework via Composer
19+
20+
You can install ApPHP into your project using [Composer](https://getcomposer.org).
21+
If you're starting a new project, we recommend using the [Directy CMF](https://github.com/apphp/directy-cmf) as
22+
a starting point. For installing new version in existing applications you can run the following:
23+
24+
``` bash
25+
$ composer require apphp/php-mvc-framework
26+
```
27+
28+
## Manual installation of ApPHP Framework
1929

2030
Please make sure the release file is unpacked under a web-accessible directory.
2131
You will see the following files and directories:
@@ -33,6 +43,31 @@ You will see the following files and directories:
3343
README this file
3444
UPDATE updating instructions
3545

46+
## Running Tests
47+
48+
Assuming you have PHPUnit installed system wide using one of the methods stated
49+
[here](https://phpunit.de/manual/current/en/installation.html), you can run the
50+
tests for ApPHP Framework by doing the following:
51+
52+
1. Install composer on your server.
53+
2. After Composer is installed, install PHPUnit by
54+
``` bash
55+
composer remove phpunit/phpunit --dev
56+
composer update
57+
```
58+
2. Make sure you added following to <strong>composer.json</strong> file:
59+
``` bash
60+
"scripts": {
61+
"tests-result": "phpunit --colors=always --log-junit test-results.xml",
62+
"tests": "phpunit --colors=always",
63+
"test": "phpunit --colors=always --filter"
64+
}
65+
```
66+
4. Run `phpunit` by:
67+
``` bash
68+
composer tests
69+
```
70+
3671
## Requirements
3772

3873
The minimum requirement by ApPHP is that your Web server supports PHP 5.4.0 or

composer.json

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
{
2+
"name": "apphp/php-mvc-framework",
3+
"type": "project",
4+
"description": "The ApPHP Framework.",
5+
"keywords": [
6+
"framework",
7+
"mvc",
8+
"rapid-development",
9+
"apphp"
10+
],
11+
"homepage": "https://apphp.com",
12+
"license": "LGPL",
13+
"authors": [
14+
{
15+
"name": "ApPHP",
16+
"homepage": "https://apphp.com/php-framework"
17+
}
18+
],
219
"config": {
320
"sort-packages": true
421
},
522
"require": {
6-
"php": ">=7.1.0"
23+
"php": ">=5.4.0"
724
},
825
"require-dev": {
926
"phpunit/phpunit": "^7.5"

0 commit comments

Comments
 (0)