From 859d51258c568528deb986d2fa16911640b38f35 Mon Sep 17 00:00:00 2001 From: Lyes Djaoui Date: Sat, 9 May 2026 18:24:22 +0200 Subject: [PATCH 1/3] add Readme.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 338a864..beb0d1f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,56 @@ > If you see this section, you've just created a repository using [PoC Innovation's Open-Source project template](https://github.com/PoCInnovation/open-source-project-template). Check the [getting started guide](./.github/getting-started.md). -# [PROJECT'S NAME] +# DISPATCH -[Project's description] +Dispatch is a streamlined issue reporting platform designed to bridge the communication gap between non-technical users and developers. By pairing a simple screen-recording extension with an automated ticketing engine, Dispatch captures the exact context of a bug or feature request. It automatically translates visual feedback into a fully structured, developer-ready ticket and routes it to the right team member, closing the loop from bug discovery to resolution. ## How does it work? -[Explain how this project is working] +Dispatch simplifies the reporting pipeline into three automated steps: + +1. Capture: Users record their screen using our dedicated browser extension exactly when a bug occurs or a feature idea comes to mind, requiring zero technical vocabulary. + +2. Process: The platform analyzes the recording alongside the environment to extract the user's intent, identify hidden errors, and gather crucial technical context. + +3. Dispatch: A fully structured, developer-ready ticket is automatically generated (complete with the video and technical data) and routed directly to the correct team member based on the project's architecture. ## Getting Started ### Installation -[Explain how to install all of the project's dependencies] +1. **Clone the repository:** + ```bash + git clone https://github.com/PoCInnovation/Dispatch.git + cd dispatch + ``` + +4. **Set up your environnement** + Duplicate the example environment file in the backend directory to create your local configuration: + ```bash + cd backend + cp .env.example .env + ``` + + Ensure your local .env file contains the required database credentials: + ```bash + POSTGRES_DB=dispatch + POSTGRES_USER=dispatch + POSTGRES_PASSWORD=dispatch + ``` ### Quickstart -[Explain how to run this project] +1. **Start the application :** + Run the following command at the root of the project to build the images and start the containers in the background: + ```bash + docker-compose up --build -d + ``` + +2. **Access the services:** + Once the containers are running, the application will be available at: + * **Frontend (Web Interface):** [http://localhost:3000](http://localhost:3000) + * **Backend (API):** [http://localhost:3001](http://localhost:3001) + * **Database (PostgreSQL):** `localhost:5432` ### Usage @@ -31,11 +65,11 @@ If you're interested in how the project is organized at a higher level, please c ## Our PoC team ❤️ Developers -| [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) | [
[Developer's name]](https://github.com/MrZalTy) +| [
LyesDjaoui](https://github.com/LyesDjaoui) | [
Lohan FERNANDES](https://github.com/lhnfe) | [
Laurent Gonzalez](https://github.com/MrZalTy) | :---: | :---: | :---: | Manager -| [
[Manager's name]](https://github.com/adrienfort) +| [
Laurent Gonzalez](https://github.com/adrienfort) | :---: |

From 80d506ee123a31607addaf438cfdef5373f717e9 Mon Sep 17 00:00:00 2001 From: Laurent Date: Fri, 22 May 2026 22:58:51 +0200 Subject: [PATCH 2/3] fix: manager --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index beb0d1f..538423c 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Developers | :---: | :---: | :---: | Manager -| [
Laurent Gonzalez](https://github.com/adrienfort) +| [
Laurent Gonzalez](https://github.com/lg-epitech) | :---: |

@@ -99,4 +99,4 @@ Organization > 🚀 Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories -> Made with ❤️ by PoC \ No newline at end of file +> Made with ❤️ by PoC From 466e0da93ae79f502a44da83ad93a9a56854df5a Mon Sep 17 00:00:00 2001 From: Laurent Date: Fri, 22 May 2026 23:00:04 +0200 Subject: [PATCH 3/3] fix: developer table --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 538423c..768cf39 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,8 @@ If you're interested in how the project is organized at a higher level, please c ## Our PoC team ❤️ Developers -| [
LyesDjaoui](https://github.com/LyesDjaoui) | [
Lohan FERNANDES](https://github.com/lhnfe) | [
Laurent Gonzalez](https://github.com/MrZalTy) -| :---: | :---: | :---: | +| [
LyesDjaoui](https://github.com/LyesDjaoui) | [
Lohan FERNANDES](https://github.com/lhnfe) +| :---: | :---: | Manager | [
Laurent Gonzalez](https://github.com/lg-epitech)