BirdTouch WebAPI

BirdTouch-Webapi

BirdTouch-Webapi é um servidor que é consumido pelo aplicativo BirdTouch Android.

O servidor está escrito no .NET 5.0 usando o banco de dados PostgreSQL.

Requisitos

• Docker
• Docker compor
• Porta 4050 para ser gratuita e não usada por nenhum aplicativo na máquina em que o Docker Daemon está executando

Instalação

• Configurar o arquivo .env (consulte a seção de configuração)
• Execute docker-compose up -d da raiz deste repositório
• Run docker-compose ps para verificar se todos os serviços estão em funcionamento
  • NOTA: O serviço database-migration deve estar na Exit 0
• Parabéns! Webapi (com banco de dados) já está disponível na porta 4050

[Opcional] Migração de banco de dados (atualização/novos scripts SQL)

Todos os scripts SQL usados ​​para criar bancos de dados e para inserir os dados necessários estão localizados na pasta de migrações.

Para adicionar novos scripts personalizados ou executar a atualização do banco de dados, siga o seguinte procedimento:

1. Crie um novo script .SQL após a Convenção de Nomeação na Pasta Migrações - a idéia é que os scripts são classificados em ordem alfabética para ter algum tipo de ordem de execução.

2. Observe que os scripts que são executados não serão executados novamente no mesmo banco de dados (para verificar se o script é executado, o nome do script é usado)

3. Quando você tiver todos os scripts necessários agora adicionados à pasta de migrações, execute:

   docker-compose up database-migration --build

Configuração

Toda a configuração é feita editando o arquivo .env.

• Alterações recomendadas:

  • Atualize POSTGRES_PASSWORD e strings de conexão usadas para acessar o banco de dados.
  • Atualize PGADMIN_DEFAULT_PASSWORD Senha usada para acessar o aplicativo PGADmin.
  • Altere JWTSecurityKey que é usado para hash dos tokens de autorização.

• Opcional:

  • RemoveInactiveUsersRunEvery a tarefa RemonsActiveSerSrune Todo
  • RemoveInactiveUsersRemoveUsersOlderThan Definir quantas horas de inatividade são consideradas para o usuário estar em estado inativo

É bom saber detalhes

Obtenção de endereço IP do contêiner WSL2 Linux

Se você estiver usando o WSL2 no Windows10 e possui contêiner Linux, onde instalou o Docker, para acessar o BirdTouch webapi (por exemplo, do cliente BirdTouch em execução no emulador Android), precisará descobrir o endereço IP da sessão do WSL2.

Faça o seguinte procedimento:

1. Faça login na máquina Linux com WSL2
2. Execute ifconfig
3. Encontre o valor net do eth0: por exemplo, seria 172.22.200.173
4. Parabéns, agora você pode acessar o seu BirdTouch webapi em execução no contêiner WSL2 Linux via 172.22.200.173:4050

Se você quiser servir webapi de você PC

1. Verifique se a porta onde o webapi está funcionando (geralmente 4050) está acessível ao mundo:
2. Caso contrário, configure para ser! :)
3. [Opcional] O site Noip.com fornece ferramentas DUC que sincronizam seu endereço IP dinâmico com algum nome de host, assim, você pode hospedar qualquer coisa do seu PC local e não se preocupar com a mudança de endereço IP