Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 2.91 KB

README.md

File metadata and controls

107 lines (72 loc) · 2.91 KB

Encurtador de URL

Este projeto é um Encurtador de URL desenvolvido utilizando o framework Hyperf. Ele oferece uma API para encurtar URLs longas e redirecionar para elas, facilitando o compartilhamento de links.

Funcionalidades

  • Encurtar URLs longas.
  • Cadastro de URLs por usuários.
  • Redirecionamento para a URL original de maneira rápida e cacheada usando Redis.

Requisitos

  • Docker e Docker Compose instalados na máquina.
  • Para uso com Kubernetes:
    • Um cluster Kubernetes configurado.
    • kubectl instalado e configurado para se comunicar com o cluster.

Configuração e Instalação

Local com Docker Compose

  1. Clone o repositório:

    git clone https://github.com/srgoogle23/encurtador-de-url.git

  2. Navegue até o diretório do projeto:

    cd encurtador-de-url

  3. Configure as variáveis de ambiente:

    • Renomeie o arquivo .env.example para .env.
    • Atualize as configurações, como informações de banco de dados, conforme necessário.

  4. Inicie os containers com Docker Compose:

    docker-compose up -d

  5. Execute as migrações para configurar o banco de dados:

    docker-compose exec encurtador php bin/hyperf.php migrate

Com Kubernetes

Nota: Caso o Kubernetes esteja configurado para usar os dados de produção, não será possível rodar as migrações diretamente. Certifique-se de utilizar a imagem de desenvolvimento para essa tarefa.

  1. Prepare a imagem do container:

    • Para produção:

      docker build -f Dockerfile -t encurtador:latest .

    • Para desenvolvimento (inclui dados de dev instalados pelo Composer):

      docker build -f .devcontainer/Dockerfile -t encurtador:latest .

  2. Configure o Kubernetes:

    • Navegue até a pasta k8 do projeto.

      cd k8

    • Aplique os manifestos na seguinte ordem:

      kubectl apply -f database/encurtador-pgsql-deployment.yml
kubectl apply -f cache/encurtador-redis-deployment.yml
kubectl apply -f app/encurtador-deployment.yml
kubectl apply -f settings/hpa.yml

  3. Execute as migrações (opcional):

    • Utilize a imagem de desenvolvimento para rodar as migrações: 
      kubectl run migrate-job --rm -i --tty \
  --image=encurtador:latest -- \
  php bin/hyperf.php migrate

Uso

Desenvolvendo documentação da API...

Desenvolvimento e Contribuição

  1. Faça um fork deste repositório.
  2. Crie uma nova branch para sua feature ou correção: git checkout -b minha-feature.
  3. Commit suas alterações: git commit -m 'Adiciona minha feature'.
  4. Envie para o repositório remoto: git push origin minha-feature.
  5. Abra um Pull Request.

Licença

Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para mais detalhes.