Skip to content

Commit 94c9f87

Browse files
committed
Add description to README.md
1 parent 7da877e commit 94c9f87

File tree

1 file changed

+68
-1
lines changed

1 file changed

+68
-1
lines changed

README.md

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
11
# HTTP Software Application Template
22

3-
The repository is under development, and the description will appear later.
3+
[![License](https://poser.pugx.org/httpsoft/http-app/license)](https://packagist.org/packages/httpsoft/http-app)
4+
[![Latest Stable Version](https://poser.pugx.org/httpsoft/http-app/v)](https://packagist.org/packages/httpsoft/http-app)
5+
[![Total Downloads](https://poser.pugx.org/httpsoft/http-app/downloads)](https://packagist.org/packages/httpsoft/http-app)
6+
[![GitHub Build Status](https://github.com/httpsoft/http-app/workflows/build/badge.svg)](https://github.com/httpsoft/http-app/actions)
7+
[![GitHub Static Analysis Status](https://github.com/httpsoft/http-app/workflows/static/badge.svg)](https://github.com/httpsoft/http-app/actions)
8+
[![Scrutinizer Code Coverage](https://scrutinizer-ci.com/g/httpsoft/http-app/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-app/?branch=master)
9+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/httpsoft/http-app/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/httpsoft/http-app/?branch=master)
10+
11+
HTTP application template for quickly creating simple but powerful web applications and APIs. «Out of the box», the application template is configured to work with JSON for rapid REST API development.
12+
13+
The core of this application template is the [httpsoft/http-basis](https://github.com/httpsoft/http-basis) microframework. By default, the [devanych/di-container](https://github.com/devanych/di-container) that implements [PSR-11](https://github.com/php-fig/container) and the [monolog/monolog](https://github.com/Seldaek/monolog) logger that implements [PSR-3](https://github.com/php-fig/log) are also used. You can easily change the container and logger to your preferred implementations of the corresponding PSRs.
14+
15+
## Documentation
16+
17+
* [In English language](https://httpsoft.org/docs/app).
18+
* [In Russian language](https://httpsoft.org/ru/docs/app).
19+
20+
## Installation
21+
22+
This project template requires PHP version 7.4 or later.
23+
24+
```bash
25+
composer create-project --prefer-dist httpsoft/http-app <app-dir>
26+
```
27+
28+
To verify the installation, go to `<app-dir>` and start the PHP built-in web server:
29+
30+
```bash
31+
cd <app-dir>
32+
composer run serve
33+
```
34+
35+
After that, open `http://localhost:8080` in your browser.
36+
37+
## Testing and checking
38+
39+
The following commands are run in the application directory:
40+
41+
* `composer run test` — runs tests.
42+
* `composer run static` — runs static analysis code.
43+
* `composer run cs-check` — runs checking coding standards.
44+
* `composer run cs-fix` — runs automatic correction of violations of encoding standards.
45+
* `composer run check` — runs checking coding standards, static analysis code and tests.
46+
47+
## Directory structure
48+
49+
By default, the application template has the following structure:
50+
51+
```
52+
bin/ Executable console scripts.
53+
chmod-var.php Recursively changing the "var/" directory mode.
54+
config/ Configuration files.
55+
config.php Main configuration.
56+
container.php Dependency injection.
57+
pipeline.php Middleware pipeline.
58+
routes.php HTTP request routes.
59+
public/ Files publically accessible from the Internet.
60+
index.php Entry script.
61+
src/ Application source code.
62+
Http/ HTTP application classes (actions, middelware, etc.).
63+
Infrastructure/ Helper classes (factories, listeners, etc.).
64+
Model/ Domain model classes (entities, repositories, etc.).
65+
tests/ A set of tests for the application.
66+
vendor/ Installed Composer packages.
67+
var/ Temporary files (logs, cache, etc.).
68+
```
69+
70+
You can change the structure of the application template as you like.

0 commit comments

Comments
 (0)