Skip to content

Latest commit

 

History

History
126 lines (73 loc) · 5.55 KB

README.md

File metadata and controls

126 lines (73 loc) · 5.55 KB

Nexte

Icon-_App-1024x1024.png

pipeline status licence MIT

O Nexte tem como objetivo promover a integração entre tenistas a partir da realização de desafios entre os membros desta comunidade. Não obstante, Nexte é desenvolvido com tecnologias modernas como: Docker, Kotlin, Node, e muitas outras.

For english support, read out README provided in english.

Primeiros Passos

É nessário realizar alguns passos antes de começar.

Prerequisitos e Instalação

Neste momento, é necessário instalar o Android Studio com a SDK 22. Se ainda não fez isso, por favor siga os passos disponibilizados na Documentação Oficial do Android.

CI e Docker

O processo de integração continua utilizada no Nexte é provida pelo GitlabCI.

Assim, o CI pode ser dividido em 4 etapas:

  1. Análise Estática: Fase que o CI a partir do docker executa a análise estática do código. Utiliza-se do Docker para realizar essa tarefa

Caso deseje executar apenas a análise estática:

  docker run -v $(pwd)/project:/application -v $(pwd)/docker/local.properties:/application/local.properties baldissera/android-container:2.1 /bin/bash "/static_analysis.sh"
  1. Testes: Fase que o CI executa os testes unitários. Utiliza-se do Docker para realizar essa tarefa.

Caso deseje executar apenas os testes:

  docker run -v $(pwd)/project:/application -v $(pwd)/docker/local.properties:/application/local.properties baldissera/android-container:2.1 /bin/bash "/test.sh"
  1. Build: Fase em que é criado uma build, .apk. Utiliza-se do Docker para realizar essa tarefa.

Caso deseje executar uma build:

  docker run -v $(pwd)/project:/application -v $(pwd)/docker/local.properties:/application/local.properties baldissera/android-container:2.1 /bin/bash "/build.sh"
  1. Deploy: Cria uma build pronta para ser disponibilizada como beta na Google Play. Esta interação do CI apenas ocorre nas branches master e dev. GitlabCI faz uso do Fastlane.

Para mais informações sobre CI e seu funcionamento acesse nosso CONTRIBUTING

  1. Para integração com o servidor, basta rodá-lo utilizando o docker para o mesmo ficar disponível em seu ambiente de desenvolvimento. O Servidor ficará disponível na porta 3000.

O comando para isso é:

  docker run -d -p 3000:3000 baldissera/nexteserver:latest

OU

  docker-compose up -d

Observações

  1. Os pull request só poderão ser aceitos caso o pipeline não tenha falhado, portanto deve-se usar os comandos do docker para validar o código, antes de gerar um Pull Request;
  2. Todos os comandos do docker deverão ser executados na raiz do programa

Deployment

Versões oficiais de deployment são disponibilizadas pelos mantedores do respositório. Mas, você pode entrar em contato com eles por issues e solicitar uma nova versão de deployment.

Ressalta-se que a partir do fastlane integrado com nosso CI, quando uma tag do GitHub é criada com a branch dev, é compilada uma nova versão de deploy pronta para ser disponibilizada como beta no Google Play, fazendo o deploy automatizado.

Construído com

Contribuindo

Por favor, leia CONTRIBUTING para detalhes do nosso código de conduta e submição de pull request.

Versões

Neste momento, ainda não há nenhuma versão de deployment para Android.

Documentação

Para saber mais sobre o projeto acesse a documentação do projeto

Autores

  • Guilherme Baldissera - Trabalho inicial - Github
  • Miguel Pimentel - Trabalho inicial - Github

Veja também a lista de contribuidores que participaram deste projeto.

Licença

Este projeto está sob a licença MIT - veja o arquivo LICENSE para mais detalhes.

Conhecimentos

  • Inspiracional
  • Utiliza as tecnologias mais recentes em desenvolvimento Android
  • Alto suporte dos mantedores

Extras

O Nexte também possui outro repositório relacionado ao servidor de imagem, este foi desenvolvido em Go e realiza o armazenamento de imagens no serviço de Cloud da Google. Estes estão disponíveis no Gitlab e Github e seguem as mesmas políticas desse projeto: