AlohomoraAPI

Logo

Descrição

AlohomoraAPI é um sistema idealizado para a gerência de portarias de condomínios e prédios. Escrito em Python com o auxílio do framework Django, o sistema visa resolver problemas de custo com portaria e fornecer autonomia aos moradores.

O sistema conta com uma ferramenta de biometria de voz, fazendo com que a voz do morador se torne a sua própria chave. Tal funcionalidade faz com que o uso de senhas se torne algo secundário.

Alohomora disponibiliza endpoints que facilitam a integração com diversos outros dispositivos e sistemas, como Telegram, por exemplo, que pode funcionar como uma ponte entre o sistema e o usuário.

Conheça também o AlohomoraBot!

Funcionalidades

Alohomora possui um conjunto de funcionalidades que possibilitam a implatação de uma portaria automatizada, dinâmica e descritiva em relação a entrada de pessoas. As funcionalidades do Alohomora podem proporcionar

Entrada do morador sem necessidade de revisão humana (porteiros)
Autonomia ao morador para gerenciar visitas mesmo não estando presente fisicamente
Controle sobre o fluxo de entradas, rastreando quem, quando e para onde

Confira as funcionalidades

Alohomora + IoT

Alohomora conta também com uma interface de comunicação baseada no Home Assistant que permite a sua integração com dispositivos de IoT, revelando um novo horizonte de expansões e melhorias para o sistema de portaria como um todo.

Instalação

Clonando o repositório

A instalação do Alohomora pode ser feita usando um terminal com a extensão do git. Também é necessário que você tenha o Docker instalado no computador. Caso você ainda não tenha, conheça o Docker.

Abra o terminal e mude para um diretório de sua escolha para receber os arquivos do repositório. Depois, execute o seguinte comando
```
$ git clone https://github.com/Alohomora-team/AlohomoraAPI.git
```
Entre dentro da pasta AlohomoraAPI e execute o comando
```
$ docker-compose build api
```

Caso tudo tenha ocorrido sem erros, a aplicação já está pronta para ser executada

Executando a aplicação

Usando o ambiente via docker-compose

Crie o build da aplicação

$ docker-compose build api

Suba o banco dados

$ docker-compose up -d db

Rode as migrações do banco de dados

$ docker-compose run api migrate

Suba o servidor django

$ docker-compose up api

Após esses comandos a aplicação estará disponível em http://localhost:8000. Os endpoints estarão acessíveis em http://localhost:8000/graphql.

Confira as funcionalidades e como as utilizar aqui.

Como contribuir

Para contribuir com o projeto confira o guia de contribuição.

Equipe

Scrum master

Felipe Borges - @bumbleblo

Product Owner

Mateus Nóbrega - @mateusnr

DevOps

Samuel Borges - @BordaLorde

Desenvolvedores

Aline Lermen - @AlineLermen

João Baraky - @baraky

Luis Furtado - @luis-furtado

Paulo Batista - @higton

Rodrigo Lima - @RodrigoTCLima

Victor Silva - @VictorJorgeFGA

Licença

Licença MIT

Alohomora-team / AlohomoraAPI

readme