Brev-ly

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

• Instalação e Uso
  • Pré-requisitos
  • Configurando Ambiente
  • Rodando localmente
  • Rodando os teste

Instalação e Uso

Pré-requisitos

Antes de começar, certifique-se de ter:

• Node.js instalado (versão recomendada: 22.16 ou superior)
• pnpm
• Conta Cloudflare com R2 habilitado
• Pulumi instalado e configurado com credenciais (para provisionar infraestrutura)
• Docker

Configurando Ambiente

1. Clonar este repositório:

   git clone https://github.com/MuriloMorandi/widget-upload.git
   cd widget-upload

2. Instale dependências (frontend e backend):

   cd web
   pnpm install
   
   cd ../server
   pnpm install

3. Configure variáveis de ambiente necessárias:

   • Servidor (backend):
     Crie o arquivo .env na pasta server/ com base no server/.env.example, adicionando suas credenciais e configurações:

     # 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:

     # 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:

     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:

     pnpm run db:migrate

Rodando localmente

1. Rode frontend e backend separadamente:

   • Servidor (backend):

     cd server
     pnpm run dev

   • Frontend:

     cd web
     pnpm run dev

Rodando os testes

• Servidor (backend):

  cd server
  pnpm run test