PauloFelipeM / fastfeet-api-go-stack

API REST para controle de transportadoras em geral.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GoStack

FastFeet API (Back-end) - GoStack10

MIT License

API REST para controle de destinatários, envios de encomendas e entregadores voltado para transportadoras.

Modulos disponíveis no momento:

Cadastro de destinatários.

GoStack10 - RocketSeat


Technologies

JavaScript (Node.js)


Requirido


Instalação

git clone https://github.com/PauloFelipeM/fastfeet-api-go-stack.git

cd /fastfeet-api-go-stack/ -> "npm install" or "yarn install"

Criar um arquivo .env e realizar as configurações necessárias da aplicação de acordo com o arquivo .env_example


Usage

Dependencias:

Dentro da sua pasta rode o comando de sua preferência para instalar as dependencias: "yarn dev" or "npm run dev"

Para modo de debug com VSCode: "yarn dev:debug"


Migração:

Criar as tabelas:

YARN: "yarn sequelize db:migrate" ou NPM: "npx sequelize-cli db:migrate"

OBS: O banco de dados já deve está criado para realizar os procedimentos acima!.

Criar usuário para autenticação:

Rodar execute o comando "yarn sequelize db:seed:all" na raiz do projeto.

Irá criar o usuário com as seguintes crendeciais:

Email: admin@fastfeet.com

Senha: 123456


Envio de E-mails:

Para realizar os envios de e-mails é necessário primeiramente configurar o banco de dados REDIS.

Após a instalação, no arquivo .env informar o REDIS_HOST (ip de onde se encontra o banco de dados) REDIS_PORT (Porta do Redis, geralmente 6379)

Para iniciar a fila de envio de e-mails é necessário rodar o comando: "yarn queue".

Após isso o gerenciamento da fila de e-mails será ativado enviado os mesmos.


🚩 Rotas e Autenticação

Veja AQUI o processo de autenticação do usuário e todas as rotas disponivéis.


📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

Criado por Paulo Felipe Martins

About

API REST para controle de transportadoras em geral.

License:Other


Languages

Language:JavaScript 98.0%Language:HTML 2.0%