Inbox API

Welcome to the Inbox API!

This is a simple, lightweight API project designed to handle conversations. It treats messages like an inbox—you send a request, and the system handles the delivery and response.

This guide will help you get it up and running and explain how the process works.

---

How to Run (Step-by-Step)

Follow these steps to prepare the environment and run the API.

---

Environment Setup

Copy the example environment file to create your local configuration:

cp .env.example .env

Edit the .env file if you need to adjust credentials or local settings.

---

Start the Containers

Launch the environment in detached mode:

docker compose up -d

---

Install Dependencies

Install the required PHP packages using Composer:

docker compose exec php composer install

---

Initialize the Project

Finalize the installation by running the internal setup command:

docker compose exec php bin/console ask:install

---

How It Works

This API is built around conversations, not just data transfer. Below is the lifecycle of a message.

---

1. The Conversation (Sending Requests)

Think of this like dropping a letter in the mail.

You send a request to the API containing your message payload.
The API receives the request, opens it, and processes your input.

---

2. Getting the Response (The Readextention Magic)

Instead of immediately returning a response, the system drafts a reply using the Readextention.

Once the API determines the answer, it edits the Readextention.

Think of the Readextention as a shared notepad or status board where responses are written.

Your application (or user) watches the Readextention and reads the response when it appears.

In short:

• You send a request
• The system edits the Readextention
• You read the result from there

---

Configuration

For adjustments to ports, database connections, or API keys, refer to the .env file.