PurpleMachinery / s4y-mail_rest_api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Visão Geral

Este documento tem como função auxiliar a instalação e uso do fake mail server.

Requisitos

  • 2 GB de RAM
  • npm instalado
  • git instalado

Dados Técnicos

Por meio de tecnologia em base de componentes, hooks (react) e linguagem funcional adaptativa (javascript), esse projeto foi feito para uso em aplicação rest por meio da biblioteca express.

Instalação

Será necessário para a instalação do produto, clonar seu repositorio no github (https://github.com/NonADev/s4y-mail_rest_api), e instalar os pacotes via npm, após isso, executar o script de inicialização do projeto.

Passo a Passo:

Para clonar o repositório, com um prompt de comando, insira o seguinte comando.

git clone https://github.com/NonADev/s4y-mail_rest_api

Logo em seguida será criado o diretório s4y-mail_rest_api, nele estará o projeto parcial referente a envio de emails. Após isso insira o comando de instalação de dependências.

npm install

Com todas as dependências devidamente instaladas, o projeto está pronto para ser executado:

npm run dev

O programa será inicializado e será executado por padrão no localhost porta 3000, então para acessá lo, basta abrir o browser atualizado, preferencialmente FireFox ou Chrome, e acessar pelo link http://localhost:3000.

Exemplificação de Uso

Por meio de padrão rest, ele aceita requisições com o protocolo GET, e nescessita de dois parametros, email e token. A requisição enviará um e-mail para a caixa de entrada 802609 do site mailtrap com o token e para o destinatario introduzido no parametro.

About


Languages

Language:JavaScript 100.0%