Update readme

.github/workflows/web-deploy.yml

@@ -9,6 +9,8 @@ on:
   pull_request:
     branches:
       - master
+    paths:
+      - "web/**"
 
   workflow_dispatch:
 

README.md

@@ -1,21 +1,21 @@
 # Brev-ly
 
+<div align="center">
+  <img src="web\public\logo_icon.svg" alt="Logo" width="100" />
+</div>
+
 Brev-ly é um encurtador de links. Este projeto tem como objetivo uma aplicação que permita o cadastro,
 listagem e remoção de links encurtados, geração de relatório dos acessos de cada links e também o
 redirecionamento correto do link encurtado para o link original.
 
----
-
 ## Índice
 
-- [Arquitetura / Tecnologias](#arquitetura--tecnologias)
 - [Instalação e Uso](#instalação-e-uso)
   - [Pré-requisitos](#pré-requisitos)
   - [Configurando Ambiente](#configurando-ambiente)
   - [Rodando localmente](#rodando-localmente)
   - [Rodando os teste](#rodando-os-testes)
 
----
 
 ## Instalação e Uso
 
@@ -50,51 +50,61 @@ Antes de começar, certifique-se de ter:
 
 3. Configure variáveis de ambiente necessárias:
 
-   Crie o `.env` com base no `server/.env.example` adicionando suas credenciais ee configurações
-
-   ```bash
-    #/server/.env.example
-    PORT=
-    DATABASE_URL=
-
-    CLOUDFLARE_ACCOUNT_ID=""
-    CLOUDFLARE_ACCESS_KEY_ID=""
-    CLOUDFLARE_SECRET_ACCESS_KEY=""
-    CLOUDFLARE_BUCKET=""
-    CLOUDFLARE_PUBLIC_URL=""
-   ```
-
-4. Inicie os serviços localmente no Docker
-
-   ```bash
-   # inicializar o container docker
-   cd server
-   docker compose up -d
-
-   # Roda as migrations do banco de dados
-   pnpm run db:migrate
-   ```
+   - **Servidor (backend):**  
+     Crie o arquivo `.env` na pasta `server/` com base no `server/.env.example`, adicionando suas credenciais e configurações:
+
+     ```bash
+     # server/.env
+     PORT=
+     DATABASE_URL=
+
+     CLOUDFLARE_ACCOUNT_ID=""
+     CLOUDFLARE_ACCESS_KEY_ID=""
+     CLOUDFLARE_SECRET_ACCESS_KEY=""
+     CLOUDFLARE_BUCKET=""
+     CLOUDFLARE_PUBLIC_URL=""
+     ```
+
+   - **Frontend:**  
+     Crie o arquivo `.env` na pasta `web/` com base no `web/.env.example`:
+
+     ```bash
+     # web/.env
+     VITE_API_URL=
+     ```
+
+4. Inicie os serviços localmente no Docker e executar as migrations
+
+   - Inicie os serviços necessários em segundo plano com o Docker:
+      ```bash
+      cd server
+      docker compose up -d
+      ```
+   - Após os containers estarem em execução, rode as migrations para aplicar as alterações no banco de dados:
+      ```bash
+      pnpm run db:migrate
+      ```
 
 ### Rodando localmente
 
 1. Rode frontend e backend separadamente:
 
-   ```bash
-   # backend
-   cd server
-   pnpm run dev
+   - **Servidor (backend):**  
+      ```bash
+      cd server
+      pnpm run dev
+       ```
 
-   # frontend
-   cd web
-   pnpm run dev
-   ```
+   - **Frontend:**  
+      ```bash
+      cd web
+      pnpm run dev
+      ```
 
 ### Rodando os testes
 
-1. Rodando os testes
-
+- **Servidor (backend):**  
    ```bash
-   # backend
    cd server
    pnpm run test
    ```