Skip to content

Commit

Permalink
docs: readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lotyp committed Nov 15, 2024
1 parent a40b3ad commit 8e554d4
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,13 @@ This starter template includes several added, changed, and removed features:
* [Deployer](https://deployer.org) for automatic deployments to staging and production servers with support of [GitHub Environments](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)
* For more information see [Deployments](#-requirements) section

### → Services

* **Added:**
* [Mailpit](https://github.com/axllent/mailpit) service to simplify email testing in development. Mailpit is an email testing tool that provides a web interface for viewing and managing test emails sent by the application.
* [MinIO](https://min.io) service for object storage, compatible with the Amazon S3 API. This enables the application to store and retrieve files in a development environment.
* [Temporal](https://temporal.io/) service is included by default for managing distributed workflows. The configuration for Temporal is located in the separate [docker-compose.temporal.yaml](./docker-compose.temporal.yaml) file, allowing easier integration with the main application.

<br>

## 🚩 Requirements
Expand Down Expand Up @@ -161,7 +168,7 @@ Check full instructions in [docker-shared-services](https://github.com/wayofdev/
make up
```

### → Laravel Starter Template
### → Spiral Starter Template

1. **Clone** repository:

Expand All @@ -180,7 +187,6 @@ Check full instructions in [docker-shared-services](https://github.com/wayofdev/

```bash
$ make env \
APP_NAME=laravel \
SHARED_SERVICES_NAMESPACE=ss \
COMPOSE_PROJECT_NAME=spiral-starter-tpl
```
Expand All @@ -191,7 +197,6 @@ Check full instructions in [docker-shared-services](https://github.com/wayofdev/

```bash
$ make env \
APP_NAME=laravel \
SHARED_SERVICES_NAMESPACE=ss \
COMPOSE_PROJECT_NAME=spiral-starter-tpl \
FORCE=true
Expand Down

0 comments on commit 8e554d4

Please sign in to comment.