Skip to content

opencodeco/twilight

Repository files navigation

Twilight: o devorador de rinhas

GitHub repo size GitHub language count GitHub forks Bitbucket open issues Bitbucket open pull requests

Projeto montado apenas em cima do Swoole e com muitas soluções in house para ganhar performance

Ajustes e melhorias

O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:

  • Configurar um projeto base
  • Preprar uma base para rodar a API
  • Definir um routeador de alta performance
  • Abstrair a infra para HTTP, Cache, Persistence e Log
  • Fazer uma PoC com todos os serviços rodando
  • Migrar a parte de persistência para uma estrutura mais formal
  • Validar se actions como funções são mais performáticas que classes

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

  • Você instalou a versão mais recente do Docker (que já vem com o plugin compose)
  • Você tem um Javinha rodando para rodar os testes
  • Você tem o ambiente preparado para rodar um makefile

🚀 Baixando o Twilight

Para começar é precisar fazer um clone deste repositório:

git clone git@github.com:opencodeco/twilight.git

Ou fazer download do zip

wget https://github.com/opencodeco/twilight/archive/refs/heads/main.zip

☕ Rodando o Twilight

Para por o projeto para rodar basta rodar o comando a serguir

make

Caso não tenha o make disponível rode na sequência:

  • docker compose run --rm setup
  • docker compose up

Para rodar o teste de stress utilize

make stress

Ou para ambientes Unix

sh ./gatling/run.sh

📫 Contribuindo para <nome_do_projeto>

Para contribuir com <nome_do_projeto>, siga estas etapas:

  1. Bifurque este repositório.
  2. Crie um branch: git checkout -b <nome_branch>.
  3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
  4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
  5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

William Correa
William Correa

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.