Skip to content

Commit 3e1df57

Browse files
committed
feat: Adiciona documentação de instalação para a extensão Cycle ORM no Express-PHP
1 parent 2a347de commit 3e1df57

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

docs/installation.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Installation
2+
3+
## Requirements
4+
5+
- PHP 8.1 or higher
6+
- Express-PHP 2.1 or higher
7+
- PDO extension
8+
- JSON extension
9+
10+
## Composer Installation
11+
12+
```bash
13+
composer require cafernandes/express-php-cycle-orm-extension
14+
```
15+
16+
## Manual Installation
17+
18+
1. Download the package
19+
2. Add to your `composer.json`:
20+
21+
```json
22+
{
23+
"require": {
24+
"cafernandes/express-php-cycle-orm-extension": "^1.0"
25+
}
26+
}
27+
```
28+
29+
3. Run `composer install`
30+
31+
## Environment Setup
32+
33+
Copy the example environment file:
34+
35+
```bash
36+
cp vendor/cafernandes/express-php-cycle-orm-extension/.env.example .env
37+
```
38+
39+
Configure your database settings in `.env`.
40+
41+
## Verification
42+
43+
To verify the installation worked:
44+
45+
```php
46+
<?php
47+
require 'vendor/autoload.php';
48+
49+
use Express\Core\Application;
50+
51+
$app = new Application();
52+
53+
// Check if Cycle ORM is available
54+
if ($app->has('cycle.orm')) {
55+
echo "✅ Cycle ORM Extension installed successfully!";
56+
} else {
57+
echo "❌ Installation failed";
58+
}
59+
```
60+
61+
## Next Steps
62+
63+
- [Configuration](configuration.md)
64+
- [Basic Usage](usage.md)
65+
- [Advanced Features](advanced.md)

0 commit comments

Comments
 (0)