Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SDK-5418: Cleanuped documentation. The part was moved to code #2467

Merged
merged 2 commits into from
Jan 22, 2024
Merged

SDK-5418: Cleanuped documentation. The part was moved to code #2467

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eff8ef5
SDK-5418: Cleanuped documentation. The part was moved to code
vol4onok Jan 22, 2024
e4d8cbe
Merge branch 'master' into feature/sdk-5418-reduce-mini-framework-files
vol4onok Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 0 additions & 53 deletions docs/acp/user/develop-an-app/develop-an-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,61 +132,8 @@ Every app requires default endpoints for the App Registry Service. This service
- Configure
- Disconnect

To be able to use your Mini Framework as an app, add a new Spryker module:

```bash
docker/sdk cli composer require spryker/app-kernel spryker/message-broker-aws spryker/propel-encryption-behavior
```

The `spryker/app-kernel` module transforms the Mini-Framework into an app. It provides SyncAPI schema and code for configuration and disconnection, as well as an AsyncAPI schema and code for the AppConfigure and AppDisconnect messages.
The `spryker/message-broker-aws` module installs the necessary plugins for sending and receiving messages.
After installing the modules, you need to configure them. See the [configuration example](https://github.com/spryker-projects/mini-framework/blob/examples/acp/hello-world/my-app-final/config/Shared/config_default.php#L28).

## Set up the message broker

Install and configure the message broker as described in [Set up the message broker](/docs/acp/user/develop-an-app/set-up-the-message-broker.html).

## Config

To be identifiable in the App Eco System, every app needs an app identifier. To provide the identifier, add the following configuration to `config/Shared/config_default.php`:

```php
use Spryker\Shared\AppKernel\AppKernelConstants;

$config[AppKernelConstants::APP_IDENTIFIER] = getenv('APP_IDENTIFIER') ?: 'hello-world';
```

## Plugins

Add some plugins to your app to enable certain functionality.

### AppRouteProviderPlugin

Add `\Spryker\Glue\App\Plugin\RouteProvider\AppRouteProviderPlugin` to the `\Pyz\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider::getRouteProviderPlugins()` method. In case the method doesn’t exist, add the complete method.

```php
<?php

namespace Pyz\Glue\GlueBackendApiApplication;

use Spryker\Glue\AppKernel\Plugin\RouteProvider\AppRouteProviderPlugin;
use Spryker\Glue\GlueBackendApiApplication\GlueBackendApiApplicationDependencyProvider as SprykerGlueBackendApiApplicationDependencyProvider;

class GlueBackendApiApplicationDependencyProvider extends SprykerGlueBackendApiApplicationDependencyProvider
{
/**
* @return array<\Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RouteProviderPluginInterface>
*/
protected function getRouteProviderPlugins(): array
{
return [
new AppRouteProviderPlugin(),
];
}
}
```

This enables the two required endpoints for the App Catalog Communication.

## Build the transfer objects

Expand Down
Loading