Inteli - Instituto de Tecnologia e Liderança

EDellcation

Dellta

🧑‍🎓 Integrantes:

Gabriel Henrique Martins Alves

Guilherme Lopes de Carvalho

Isabelly Maia Montalvão

Mirella Borim Lima

Paulo Henrique Ribeiro

Thiago Gomes de Almeida

🧑‍🏫 Professores:

Orientador(a)

• Claudio André - Professor Doutor em Educação & Orientador da Turma 13 no Módulo 2 de 2024

Claudio André

Instrutores

• André Godoi - Professor de Programação do Módulo 2
• Bruna Mayer - Professora de UX design do Módulo 2
• Fernando Pizzo - Professor de matemática do Módulo 2
• Fillipe Resina - Professor de Programação do Módulo 2
• Michele Banzana - Professora de liderança do Módulo 2
• Renato Penha - Professor de negócios do Módulo 2

André Godoi

Bruna Mayer

Fernando Pizzo

Fillipe Resina

Michele Banzana

Renato Penha

📝 Descrição

 Esta solução se refere ao projeto proposto no segundo módulo do Instituto de Tecnologia e Liderança (INTELI), onde os alunos devem desenvolver uma aplicação web. Neste caso, a aplicação foi desenvolvida para a empresa Dell, com o intuito de resolver o problema dos funcionários que trabalham na linha de montagem e não possuem uma plataforma de fácil acesso aos manuais de montagem.

 EDellcation é uma solução que centraliza os manuais de treinamento da Dell em uma única plataforma, organizando os estudos e conhecimentos dos montadores da empresa. A plataforma gera métricas sobre o nível dos funcionários, fornecendo maior segurança na tomada de decisões ao manipular as linhas de montagem. O grande diferencial da EDellcation é a facilidade de acesso às ferramentas do site com poucos cliques.

 Com a aplicação desta plataforma, o grupo Dellta visa a concentração de todas as informações importantes no processo de montagem dos computadores, tornando fácil a localização e busca por manuais que auxiliarão os montadores no momento da montagem, tornando os processos mais eficientes.

📝 Link de demonstração

 Acesse o site publicado na plataforma Render clicando aqui.

 Acesse o vídeo de demonstração do site em funcionamento clicando aqui

Atenção: Data de expiração do banco de dados dia 14/09/2024

📁 Estrutura de pastas

Dentre os arquivos e pastas presentes na raiz do projeto, definem-se:

• api: aqui estão os arquivos principais do aplicativo, incluindo controladores (controllers), modelos (models), políticas (policies) e serviços (services) do Sails.

• assets: aqui estão os arquivos relacionados a elementos não-estruturados deste repositório, como imagens.

• config: contém todos os arquivos de configuração para o aplicativo, incluindo configurações de banco de dados, middleware, rotas e outros aspectos importantes do Sails.

• documents: aqui estão todos os documentos do projeto, como o Web Application Document (WAD) bem como documentos complementares, na pasta "other".

• tasks: contém as definições de tarefas automatizadas usando o Grunt, que é o gerenciador de tarefas padrão do Sails.

• tests: aqui estão os testes automatizados do projeto.

• views: contém os arquivos de visualização (views) do Sails, como arquivos EJS, que são usados para renderizar as respostas HTML para o cliente.

• .editorconfig: arquivo de configuração para manter estilos de codificação consistentes entre diferentes editores e IDEs.

• .eslintignore: lista de arquivos e diretórios que devem ser ignorados pelo ESLint, o analisador de código estático.

• .eslintrc: arquivo de configuração para o ESLint, que define as regras e ambientes de linting para o projeto.

• .gitignore: lista de arquivos e diretórios que o Git deve ignorar, evitando que sejam versionados no repositório.

• .npmrc: arquivo de configuração para o npm, que pode incluir configurações de proxy, registro de pacotes, etc.

• .sailsrc: arquivo de configuração específico para o Sails, que pode conter configurações de ambiente, hooks personalizados, entre outros.

• app.js: ponto de entrada principal da aplicação Sails, onde a aplicação é inicializada e configurada.

• Gruntfile.js: arquivo de configuração para o Grunt, definindo as tarefas automatizadas que serão executadas durante o desenvolvimento e implantação.

• package-lock.json: arquivo gerado automaticamente que descreve a árvore de dependências exata instalada para o projeto, garantindo builds reprodutíveis.

• package.json: arquivo de configuração do npm que descreve o projeto, incluindo suas dependências, scripts, autor, licença e outras metadatas importantes.

• README.md: arquivo que serve como guia introdutório e explicação geral sobre o projeto e a aplicação (o mesmo arquivo que você está lendo agora).

💻 Configuração para desenvolvimento e execução do código

1. Baixar e Instalar o Node.js:
   • Baixe a versão recomendada (16.15.1 LTS ou mais recente) do Node.js no site oficial.
   • Siga as instruções de instalação específicas para o seu sistema operacional.
2. Instalar o Sails.js:
   • Com o Node.js instalado, abra o terminal e instale o Sails.js globalmente usando o npm:

     npm install -g sails

3. Clonar o Repositório:
   • Use o Git para clonar o repositório do projeto. No terminal, execute:

     git clone <https://github.com/Inteli-College/2024-1B-T13-IN02-G04>

4. Instalar Dependências:
   • Navegue até a pasta raiz do repositório clonado e depois entre na pasta api, onde estão os componentes backend do projeto:

     cd <2024-1B-T13-IN02-G04>
     cd api

   • Instale as dependências necessárias executando:

     npm install

   • Isso irá instalar todas as dependências listadas no arquivo package.json.
5. Configurar Variáveis de Ambiente:
   • Crie um arquivo .env na raiz do projeto ou ajuste as configurações no arquivo config/env/development.js conforme necessário. Este arquivo deve conter variáveis de ambiente específicas para o ambiente de desenvolvimento, como chaves de API, strings de conexão de banco de dados, etc.
6. Iniciar a Aplicação:
   • Após a instalação das dependências e configuração das variáveis de ambiente, inicie a aplicação com o comando:

     sails lift

   • Para iniciar a aplicação em um modo mais seguro (sem resetar os dados), use:

     sails lift --safe

   • Este comando inicializa o servidor Sails e sua aplicação estará em execução.
7. Acessar a Aplicação:
   • Com o servidor em execução, acesse a aplicação no navegador através do endereço:

     http://localhost:1337/
     

   • Este URL levará você à interface da aplicação, onde você pode interagir com o sistema e verificar sua execução.
8. Servidor Online:
   • O servidor está agora online e sua aplicação está pronta para ser utilizada e modificada conforme necessário.
9. Monitoramento e Logs:
   • Para monitorar logs e erros, use as opções integradas do Sails.js ou ferramentas de log externas conforme necessário. Por exemplo:

     sails console

   • Isso permite que você execute comandos diretamente no contexto da sua aplicação.

---

🗃 Histórico de lançamentos

• 0.5.1 - 20/06/2024
  • 0.5.1 - Correção de bug na homepage do engenheiro.
  • 0.5.0 - Versão final do MVP.
• 0.4.1 - 11/06/2024
  • 0.4.1 - Remoção de bugs na tela de pesquisa.
  • 0.4.0 - Primeira versão funcional.
• 0.3.1 - 27/05/2024
  • 0.3.1 - Organização das pastas do projeto
  • 0.3.0 - Desenvolvimento intermediário
• 0.2.0 - 10/05/2024
  • Desenvolvimento básico
• 0.1.0 - 26/04/2024
  • Entendimento do problema, do negócio e do produto.

📋 Licença/License

EDellcation by INTELI, Gabriel Henrique Martins Alves, Guilherme Lopes de Carvalho, Isabelly Maia Montalvão, Mirella Borim Lima, Paulo Henrique Ribeiro , Thiago Gomes de Almeida is licensed under Creative Commons Attribution 4.0 International