pedrohlisboa-261 / siga-api

siga-api

---

API para mensageria integrada aos gatilhos do Oracle Field Service

📝 Índice

• Sobre a aplicação
• Por onde começar?
• Como usar?
• Deployment
• Tecnologias utilizadas
• Requisitos
• Autores
• Agradecimentos

🧐 Sobre a aplicação

A aplicação tem como objetivo possibilitar a consulta de informações de contato dos clientes em diferentes bases de dados e enviar o link de acompanhamento de serviços através do whatsapp, complementando as funcionalidades do OFS / Where's my tech (Oracle).

🏁 Por onde começar?

O webservice foi construído com a utilização do Node.js (16.13.0) no ambiente de desenvolvimento corporativo e se conecta com as principais APIs e bancos de dados da companhia. Atente-se aos pré-requisitos.

Pré-requisitos

• Node.js
• Oracle Client Database
  👉🏽 Veja a FAQ#05 - Instalação do Oracle 11g Client no Windows

Instalando as dependências

Para instalar as dependências do projeto execute no seu prompt de comandos:

Com o npm:

npm i

ou yarn:

yarn

Recomendamos a utilização do yarn por questões de performance.

🎈 Como usar?

1. Crie o arquivo .env na raiz do projeto. Existe um .env.example com instruções para as informações que deversão ser preenchidas;
2. Preencha os campos do arquivo knexfile.ts que está na raiz do projeto.
3. Execute o script dev para executar a aplicação no ambiente de desenvolvimento. Exemplo:

yarn dev

4. Para ver a documentação no Swagger acesse http://localhost:{API_PORT}/docs.

🚀 Deployment

Para efetuar o deploy da aplicação acesse a FAQ#03 - Proxy reverso e deploy de aplcações Node.js com Nginx.

⛏️ Tecnologias utilizadas:

• Node.js - Server Environment
• Express - Server Framework
• Typescript - Superset Javascript
• Knex.js - Query builder
• ESLint - Javascript linter

✍️ Autores

• @robertotics4 - Desenvolvimento
• @pedrohlisboa-261 - Desenvolvimento

🎉 Agradecimentos

Agradecimentos à toda a equipe de Transformação Digital pelo espírito de união e por todas as conquistas que alcançamos juntos. Trabalhar ao lado de pessoas tão companheiras e generosas é um grande privilégio.