EndoAI

Descrição

O projeto desenvolvido é uma interface para um modelo de machine learning que tem como principal diretriz a prevenção de casos de diabetes, sempre incentivando o usuário a buscar o diagnóstico de um profissional da saúde. Mais informações podem ser encontradas em nosso google sites e nosso drive.

Requisitos

Para rodar este projeto é necessário cumprir os seguintes requisitos:

• Python 3.12.3 ou superior;
• npm 10.9.2 ou superior;
• node 18.19.1 ou superior

Execução

Para executar o projeto, é necessário seguir os seguintes passos:

• Clonando o respositório:

  • Clone o repositório para a sua máquina usando o comando:

    git clone https://github.com/paulo-campos-57/EndoAI.git
    

  • Em seguida, baixe os seguintes arquivos, e os adiciones nas respectivas pastas:

    • Insira esse arquivo na pasta EndoAI/backend: joblib(back-end)
    • [Modelo simplificado] -> Insira esse arquivo na pasta EndoAI/backend/app: joblib Simp
    • [Modelo simplificado] -> Insira esse arquivo na pasta EndoAI/backend/app: Modelo KNN Simp
    • [Modelo Estendido] -> Insira esse arquivo na pasta EndoAI/backend/app: joblib Ex
    • [Modelo Estendido] -> Insira esse arquivo na pasta EndoAI/backend/app: Modelo KNN Ex
• Iniciando o servidor Back-end:

  • Navegue até a pasta backend do projeto (EndoAI/backend)

  • Inicie o ambiente virtual:

      python -m venv venv
    

  • Em seguida ative o ambiente virtual:

      source venv/bin/activate # Para sistemas linux
    

      .\venv\Scripts\activate # Para sistemas windows
    

  • Instale os requisitos para o back-end no ambiente virtual:

      pip install -r requirements.txt
    

  • Testando o back-end:

    • Após a instalação dos requisitos no ambiente virtual, ainda na pasta EndoAI/backend execute o comando:

      pytest
      

  • Após a instalação e testes, navegue até a pasta app (EndoAI/backend/app) e execute o comando:

      python ./app.py
    

  • Com isto, o servidor estará rodando na porta 5000.

• Iniciando o servidor Front-end

  • Navegue até a pasta de frontend do projeto (EndoAI/frontend/endo-front) e execute o comando:

    npm install
    

  • Testando o front-end:

    • Ainda na pasta EndoAI/frontend/endo-front, execute o comando:

      npm test
      

    • Em seguida, pressione a (para rodar todos os testes)

    • Com a finalização, pressione Ctrl + C para encerrar os testes

  • Após os testes, execute o comando:

    npm start
    

  • Com isto, o servidor estára rodando na porta 3000, e acessível via url http://localhost:3000/

Description

The developed project is an interface for a machine learning model primarily aimed at preventing diabetes cases, always encouraging the user to seek a diagnosis from a healthcare professional. More information can be found on our Google Sites and our Drive.

Requirements

To run this project, the following requirements must be met:

• Python 3.12.3 or higher;
• npm 10.9.2 or higher;
• node 18.19.1 or higher;

How to run

To run this project, is necessary to follow the following steps:

• Cloning the repository:

  • Clone the repository to your machine using the command:

    git clone https://github.com/paulo-campos-57/EndoAI.git
    

  • Then, download the following files and add them to their respective folders:

    • Place this file in the EndoAI/backend folder: joblib (back-end)
    • [Simplified Model] -> Place this file in the EndoAI/backend/app folder: joblib (app)
    • [Simplified Model] -> Place this file in the EndoAI/backend/app folder: KNN Model
    • [Extended Model] -> Place this file in the EndoAI/backend/app folder: joblib Ex
    • [Extended Model] -> Place this file in the EndoAI/backend/app folder: KNN Model Ex

• Starting Back-end server:

  • Go to the project backend folder (EndoAI/backend).

  • Create the virtual enviroment:

      python -m venv venv
    

  • After that start the virtual enviroment:

      source venv/bin/activate # For linux system
    

      .\venv\Scripts\activate # For windows system
    

  • Install the requirements for the back-end in the virtual enviroment:

      pip install -r requirements.txt
    

  • Testing the back-end:

    • After installing the requirements at the virtual enviroment, still at the EndoAI/backend folder use the command:

      pytest
      

  • After running the tests and the installation, go to the app folder (EndoAI/backend/app) and use the command:

      python ./app.py
    

  • After that, the server will be running in port 5000.

• Starting the Front-end server

  • Go to the project frontend folder (EndoAI/frontend/endo-front) and use the command:

    npm install
    

  • Testing the front-end:

    • Still at the EndoAI/frontend/endo-front folder, use the command:

      npm test
      

    • After that, press a (to run all the tests)

    • Once they're done, press Ctrl + C to finish the tests

  • After the tests, use the command:

    npm start