AGIS

Este repositório contém o projeto AGIS desenvolvido com Node.js, React, TypeScript e Electron. Neste arquivo README, você encontrará um guia passo a passo para executar o projeto em seu ambiente local.

Sobre o projeto

O AGIS é uma aplicação desktop de gestão de recursos humanos, que visa fornecer todas as funcionalidades desejadas pelo cliente, como a geração de relatórios e geração de campanhas - calendário que mostra quem está apto a trabalhar no dia e mês.

Autores:

Adriano Fonseca	Ana Julia	Arthur Sousa	Caua Araujo	Ian Costa	Necivaldo Amaral	Pedro Luiz	Weverton Rodrigues

Pré-requisitos

Antes de começar, verifique se você possui as seguintes ferramentas instaladas em sua máquina:

• Node.js (versão 20 ou superior)
• npm (gerenciador de pacotes do Node.js)
• Docker

Passo 1: Clonar o repositório

Comece clonando este repositório em uma pasta da sua máquina local. Abra o terminal e execute o seguinte comando:

git clone https://github.com/FGA0138-MDS-Ajax/2024.1-CYGNI.git

Isso criará uma cópia local do repositório em seu ambiente.

Passo 2: Instalar dependências

Navegue até o diretório raiz do projeto e execute os seguintes comandos para instalar as dependências do Node.js:

cd 2024.1-CYGNI\back
npm i
cd ..
cd front
npm i

Esse comando irá ler o arquivo package.json e instalar todas as dependências necessárias para o projeto.

Passo 3: Configurar variáveis de ambiente

O projeto exige algumas variáveis de ambiente para funcionar corretamente. Verifique se existe um arquivo .env.example na pasta back do projeto. Faça uma cópia desse arquivo e renomeie-o para .env. Em seguida, atualize as variáveis de ambiente de acordo com as configurações do seu ambiente local.

Passo 4: Iniciar o servidor

Para iniciar o servidor Node.js, execute o seguinte comando no powershell:

cd back
docker compose up --build

Isso iniciará o servidor e você poderá acessá-lo através da sua máquina no endereço http://localhost:80.

Passo 5: Iniciar o Docker pelo terminal

O projeto roda localmente no Docker. Após executar o comando anterior, acesse o contêiner do backend e banco de dados, em MongoDB 6.0 (mongodb:6.0). Navegue até o banco de dados (em "Exec") e execute os seguintes comandos para criar um administrador:

docker exec mongodb mongosh --username agisagent 

password: Agis@2024

db.administradors.insertOne({login: "SeuNome", senha: "HashdeSuaSenha", privilegios: true, email: "[email protected]"});

db.administradors.find() // serve para conferir se seu cadastro foi um sucesso ou não.

Passo 5.1 Iniciar o Docker pelo Docker Desktop

Pelo Docker Desktop acessando o contêiner do backend e banco de dados, em MongoDB 6.0 (mongodb:6.0). Navegue até o banco de dados (em "Exec") e execute os seguintes comandos para criar um administrador:

mongosh --username agisagent 

password: Agis@2024

db.administradors.insertOne({login: "SeuNome", senha: "HashdeSuaSenha", privilegios: true, email: "[email protected]"});

db.administradors.find() // serve para conferir se seu cadastro foi um sucesso ou não.

Passo 6: Rodar o Front-end

cd front
npm run dev

Com esses passos, você poderá acessar o AGIS e aproveitar suas funcionalidades.

Passo Extra: Hashear sua senha

Para transformar sua senha em hash, siga os passos abaixo:

1. Crie uma nova pasta:

   • Crie uma pasta chamada bcrypt na sua máquina.

2. Crie um arquivo index.js:

   • Dentro da pasta bcrypt, crie um arquivo chamado index.js e cole o seguinte código:

   import * as bcrypt from "bcrypt";
   
   const senha = "suaSenha"; // aqui você modifica para a senha que desejar
   
   const hasher = async () => {
       const hash = await bcrypt.hash(senha, 16);
       console.log(hash);
   };
   
   hasher();

3. Mude o package.json

• Abra o package.json e embaixo de "name: index" digite "type": "module". Assim que deve ficar seu package modificado:

{
"name": "index",
"type": "module",
...
}

4. Instale as dependências:

   • Abra o PowerShell, navegue até a pasta bcrypt e execute os seguintes comandos:

   npm init -y
   npm install bcrypt
   node index.js

   Esses comandos irão inicializar um novo projeto Node.js, instalar o pacote bcrypt e executar o código para gerar o hash da senha. O hash será exibido no console.

---

Licença

Esse projeto está sob licença: MIT.

---

Modelo

Esse README foi feito seguindo o template

---