Merge pull request #2030 from brefphp/delete-bref-cli

Delete the `bref` CLI (Bref v3)

Author: mnapoli

.phpcs.xml

@@ -7,7 +7,6 @@
     <!-- Show sniff names -->
     <arg value="s"/>
 
-    <file>bref</file>
     <file>src</file>
     <file>tests</file>
 

bref

@@ -16,7 +16,6 @@
         }
     },
     "bin": [
-        "bref",
         "src/bref-local"
     ],
     "require": {

composer.json

@@ -27,33 +27,29 @@ Next, in an empty directory, install Bref using Composer:
 composer require bref/bref
 ```
 
-Make sure that the version of Bref that was installed is 1.0 or greater.
+Make sure that the version of Bref that was installed is 3.0 or greater.
 
-Then let's start by initializing a new project by running:
+Then, create a `serverless.yml` file. This file will describe how to deploy your application.
 
-```bash
-vendor/bin/bref init
-```
-
-Accept all the defaults by pressing "Enter". The following files will be created in your project:
-
-- `index.php` contains the code of your application
-- `serverless.yml` contains the configuration for deploying on AWS
-
-You are free to edit `index.php`.
+```yml filename="serverless.yml"
+service: app # your application name (lowercase without spaces)
 
-To deploy an existing application, you can delete `index.php` and edit `serverless.yml` to point to your existing index file (for example it may be another file like `public/index.php`). You can also create the `serverless.yml` file manually:
+bref:
+    # Uncomment and set your team ID if you are using Bref Cloud
+    #team: bref-team-id
 
-```yml filename="serverless.yml"
-service: app
 provider:
     name: aws
-    region: us-east-1
+    region: us-east-1 # AWS region to deploy to
+    environment: # Environment variables
+        APP_ENV: prod
 
 functions:
     web:
+        # `index.php` is the entrypoint of your application
         handler: index.php
         runtime: php-84-fpm
+        timeout: 28 # in seconds (API Gateway has a max timeout of 29 seconds)
         events:
             -   httpApi: '*'
 
@@ -66,6 +62,21 @@ plugins:
     - ./vendor/bref/bref
 ```
 
+If your `index.php` entrypoint is in a different folder, feel free to adjust the `handler` key. For example if it is in `public/index.php`:
+
+```yml
+        handler: public/index.php
+```
+
+If this is a new application, you can create a very simple `index.php` file to test things out, for example:
+
+```php
+<?php
+echo 'Hello world!';
+```
+
+You will also want to add `.serverless` to your `.gitignore`.
+
 ## Deployment
 
 To deploy, run:

docs/default/getting-started.mdx

@@ -21,13 +21,54 @@ Next, in an existing Symfony project, install Bref and the [Symfony Bridge packa
 composer require bref/bref bref/symfony-bridge --update-with-dependencies
 ```
 
-Next, create a `serverless.yml` configuration file at the root of your project by running:
-
-```bash
-vendor/bin/bref init symfony
+Next, create a `serverless.yml` configuration file at the root of your project:
+
+```yml filename="serverless.yml"
+service: app # your application name (lowercase without spaces)
+
+bref:
+    # Uncomment and set your team ID if you are using Bref Cloud
+    #team: bref-team-id
+
+provider:
+    name: aws
+    region: us-east-1 # AWS region to deploy to
+    environment: # Environment variables
+        APP_ENV: prod
+
+functions:
+    # This function runs the Symfony website/API
+    web:
+        handler: public/index.php
+        runtime: php-84-fpm
+        timeout: 28 # in seconds (API Gateway has a max timeout of 29 seconds)
+        events:
+            -   httpApi: '*'
+    # This function let us run console commands in Lambda
+    console:
+        handler: bin/console
+        runtime: php-84-console
+        timeout: 120 # in seconds
+
+package:
+    patterns:
+        # Excluded files and folders for deployment
+        - '!assets/**'
+        - '!node_modules/**'
+        - '!public/build/**'
+        - '!tests/**'
+        - '!var/**'
+        # If you want to include files and folders that are part of excluded folders,
+        # add them at the end
+        - 'var/cache/prod/**'
+        - 'public/build/entrypoints.json'
+        - 'public/build/manifest.json'
+
+plugins:
+    - ./vendor/bref/bref
 ```
 
-(you can preview that file [here](https://github.com/brefphp/bref/blob/master/template/http/serverless.yml))
+You will also want to add `.serverless` to your `.gitignore`.
 
 You still have a few modifications to do on the application to make it compatible with AWS Lambda.
 

docs/symfony/getting-started.mdx

@@ -1,7 +1,6 @@
 parameters:
   level: 5
   paths:
-    - bref
     - src
     - tests
   excludePaths: