Bio Shield

Sobre o projeto

Bio Shield: SISTEMA DE IDENTIFICAÇÃO E AUTENTICAÇÃO BIOMÉTRICA FACIAL é um projeto tem como objetivo demonstrar a implementação de um sistema de segurança baseado em validação biométrica facial, garantindo o acesso ao cofre oculto no Ministério do Meio Ambiente. O sistema será estruturado em três níveis de segurança:

Nível 1: Acesso concedido a indivíduos com permissão geral.
Nível 2: Acesso restrito a diretores de divisões.
Nível 3: Acesso exclusivo ao ministro do Meio Ambiente.

Através dessa abordagem, buscamos assegurar que apenas usuários autorizados possam acessar informações sensíveis, contribuindo para a proteção de dados críticos.

Estrutura do Pastas

Bio-Shield
├── backend  # Código-fonte e configurações do backend do projeto em Django.
│   ├── media # Arquivos de mídia (imagens) enviados pelos usuários.
│   ├── project  # Configurações do projeto Django.
│   ├── .env  # Arquivo de configuração de variáveis de ambiente.
│   ├── .env.example  # Exemplo de arquivo de configuração de variáveis de ambiente.
│   ├── .gitignore  # Arquivo de configuração do Git.
│   ├── docker-compose.yml  # Arquivo de configuração do Docker Compose.
│   ├── manage.py  # Script de gerenciamento do projeto Django.
│   ├── poetry.lock  # Arquivo de lock do Poetry.
│   ├── pyproject.toml  # Arquivo de configuração do Poetry.
│   └── README.md  # Documentação do backend.
│
├── frontend  # Código-fonte e configurações do React
│   ├── node_modules  # Dependências do projeto.
│   ├── public  # Arquivos públicos do projeto.
│   ├── src  # Código-fonte do projeto.
│   ├── .gitignore  # Arquivo de configuração do Git.
│   ├── components.json # Arquivo de configuração do Shadcn UI.
│   ├── eslint.config.js # Arquivo de configuração do ESLint.
│   ├── index.html  # Página HTML do projeto.
│   ├── package.json  # Arquivo de configuração do NPM.
│   ├── package-lock.json  # Arquivo de lock do NPM.
│   ├── postcss.config.js  # Arquivo de configuração do PostCSS.
│   ├── README.md  # Documentação do frontend.
│   ├── tailwind.config.js  # Arquivo de configuração do Tailwind CSS.
│   ├── tsconfig.json  # Arquivo de configuração do TypeScript.
│   ├── tsconfig.app.json  # Arquivo de configuração do TypeScript.
│   ├── tsconfig.node.json  # Arquivo de configuração do TypeScript.
│   └── vite.config.ts  # Arquivo de configuração do Vite.
│
└── README.md  # Documentação principal do projeto.

Tecnologias Utilizadas

Backend

• Python
• Django
• Django REST framework
• Poetry

Frontend

• Node.js
• NPM
• React
• TypeScript
• Vite
• Tailwind CSS
• Shadcn UI
• ESLint
• Prettier
• PostCSS

Banco de Dados

• PostgreSQL

DevOps

• Git
• Docker
• Docker Compose
• GitHub Actions
• Azure

Pré-requisitos

• Python
• Poetry
• Node.js
• NPM
• Docker
• Docker Compose
• Git

Rodando Localmente

1. Clone o repositório

git clone https://github.com/LeoPDA/bio-shield.git

2. Entre na pasta do projeto

cd bio-shield

Backend

Entre na pasta do backend

cd backend

Crie um arquivo .env na raiz do projeto

touch .env

Copie o conteúdo do arquivo .env.example para o arquivo .env

cp .env.example .env

Instale as dependências

poetry install

Inicie o ambiente virtual

poetry shell

Execute as migrações

python manage.py migrate

Crie um superusuário

python manage.py createsuperuser

Inicie o servidor

python manage.py runserver

Frontend

Entre na pasta do frontend

cd frontend

Instale as dependências

npm install

Inicie o aplicativo

npm run dev

Acesse o aplicativo em http://localhost:5173

Funcionalidades

• Em breve

Desenvolvedores

• Rafael Ferreira Machado
• Kayky Vasconcelos
• Leonardo Arouche
• Samara Marques
• Thais