Skip to content

Commit 5117804

Browse files
arhimedearhimede
authored
Merge pull request #7 from dotkernel/arhimede
FIle linting
2 parents 480c7b5 + 2f2cd21 commit 5117804

File tree

4 files changed

+33
-29
lines changed

4 files changed

+33
-29
lines changed

‎docs/book/v4/installation/configuration-files.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,22 @@
22

33
## Prepare config files
44

5-
* duplicate `config/autoload/cors.local.php.dist` as `config/autoload/cors.local.php`
6-
#### Note
5+
* duplicate `config/autoload/cors.local.php.dist` as `config/autoload/cors.local.php`
6+
7+
### Note
8+
79
> if your API will be consumed by another application, make sure to configure the `allowed_origins` variable
810
911
* duplicate `config/autoload/local.php.dist` as `config/autoload/local.php`
1012

11-
* duplicate `config/autoload/mail.local.php.dist` as `config/autoload/mail.local.php`
13+
* duplicate `config/autoload/mail.local.php.dist` as `config/autoload/mail.local.php`
1214

1315
### Note
14-
> if your API will send emails, make sure to fill in SMTP connection params
1516

17+
> if your API will send emails, make sure to fill in SMTP connection params
1618
1719
* **optional**: in order to run/create tests, duplicate `config/autoload/local.test.php.dist` as `config/autoload/local.test.php`
1820

1921
### Note
22+
2023
> this creates a new in-memory database that your tests will run on.

‎docs/book/v4/installation/faq.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
If running your project you encounter some permission issues, follow the below steps.
66

7-
### Errors:
7+
### Errors
88

99
> PHP Fatal error: Uncaught InvalidArgumentException: The directory "/var/www/_example.local_/html/data" is not writable...
1010
@@ -18,7 +18,7 @@ If running your project you encounter some permission issues, follow the below s
1818
chmod -R 777 data
1919
```
2020

21-
### Error:
21+
### Error
2222

2323
> PHP Fatal error: Uncaught InvalidArgumentException: The directory "/var/www/_example.local_/html/public/uploads" is not writable...
2424
@@ -28,7 +28,7 @@ chmod -R 777 data
2828
chmod -R 777 public/uploads
2929
```
3030

31-
### Error:
31+
### Error
3232

3333
> PHP Fatal error: Uncaught ErrorException: fopen(/var/www/_example.local_/config/autoload/../../log/error-log-_yyyy-mm-dd.log_): Failed to open stream: Permission denied...
3434

‎docs/book/v4/introduction/file-structure.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ We recommend using the following directory structure:
5757

5858
* `data/cache` - location where caches are stored
5959
* `data/oauth` - encryption, private and public keys needed for authentication.
60-
* `data/doctrine` - fixtures and migrations
60+
* `data/doctrine` - fixtures and migrations
6161
* `data/lock` - lock files generated by `dotkernel/dot-cli` [See more](https://docs.dotkernel.org/dot-cli/v3/lock-files/)

‎docs/book/v4/transition-from-api-tools/api-tools-vs-dotkernel-api.md‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
## Comparison between API Tools and DotKernel API
1+
# Comparison between API Tools and DotKernel API
22

3-
| | API Tools (Apigility) | DotKernel API |
4-
|--------------------|------------------------------------------------|--------------------------------------------------------------------------|
5-
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6-
| First Release | 2012 | 2018 |
7-
| PHP Version | <= 8.2 | >= 8.1 |
8-
| Architecture | MVC, Event Driven | Middleware |
9-
| OSS Lifecycle | Archived | ![](https://img.shields.io/osslifecycle/dotkernel/api?style=flat&label=) |
10-
| Style | REST, RPC | REST |
11-
| Versioning | Yes | No * |
12-
| Documentation | Swagger (Automated) | Postman (Manual) |
13-
| License | BSD-3 | MIT |
14-
| Default DB Layer | laminas-db | doctrine-orm |
15-
| Authorization | ACL | RBAC-guard |
16-
| Authentication | HTTP Basic/Digest <br/> OAuth2.0 | OAuth2.0 |
17-
| CI/CD | Yes | Yes |
18-
| Unit Tests | Yes | Yes |
19-
| Endpoint Generator | Yes | Under development |
20-
| PSR | PSR-7 | PSR-7, PSR-15 |
3+
| | API Tools (Apigility) | DotKernel API |
4+
|---------------------|---------------------------------------------|----------------------------------------------------------------------------------------|
5+
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6+
| First Release | 2012 | 2018 |
7+
| PHP Version | <= 8.2 | >= 8.1 |
8+
| Architecture | MVC, Event Driven | Middleware |
9+
| OSS Lifecycle | Archived | ![OSs Lifecycle](https://img.shields.io/osslifecycle/dotkernel/api?style=flat&label=) |
10+
| Style | REST, RPC | REST |
11+
| Versioning | Yes | No * |
12+
| Documentation | Swagger (Automated) | Postman (Manual) |
13+
| Content-Negotiation | Custom | Hardcoded (hal+json, json) |
14+
| License | BSD-3 | MIT |
15+
| Default DB Layer | laminas-db | doctrine-orm |
16+
| Authorization | ACL | RBAC-guard |
17+
| Authentication | HTTP Basic/Digest OAuth2.0 | OAuth2.0 |
18+
| CI/CD | Yes | Yes |
19+
| Unit Tests | Yes | Yes |
20+
| Endpoint Generator | Yes | Under development |
21+
| PSR | PSR-7 | PSR-7, PSR-15 |
2122

23+
## Note
2224

23-
### Note
24-
> * Versioning is not planned at all. [Quote from Roy T. Fielding](https://twitter.com/fielding/status/376835835670167552)
25+
> * Versioning is not planned at all. [Quote from Roy T. Fielding](https://twitter.com/fielding/status/376835835670167552)

0 commit comments

Comments
 (0)