Api NovaEscola

ℹ️ Principais objetivos do projeto:

Fazer BACKEND de um CRUD clássico para Cliente com as funcionalidades abaixo:

Cadastro do cliente
Listagem do cliente
Detalhamento do cliente
Alteração do cliente
Remoção do cliente

🚀 Tecnologias

Esse projeto foi desenvolvido para o desafio da Nova Escola com as tecnologias a seguir:

ℹ️ How To Use

To clone and run this application, you'll need Git, [Node.js v10.16][nodejs] or higher + [Yarn v1.13][yarn] or higher installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/dandpb/apiNovaEscola

# Go into the repository
$ cd apiNovaEscola

# instalar dependências
$ yarn install

#criar o banco de dados no mysql
create database api_nova_escola_db;

#rodar migrations
yarn sequelize db:migrate

# rodar a aplicação
$ yarn dev

# rodar a aplicação no modo de debugger
$ yarn dev:debugger

📝 Como testar as request's

Usar o Insomnia, importar o workspace pegando o arquivo 'insomnia_api_nova_escola.json' na raiz do projeto para testar localmente.

Usar o Insomnia, importar o workspace pegando o arquivo 'insomnia_api_nova_escola_servidor_externo.json' na raiz do projeto para testar externamente. A api está hospedada no endereço http://novaescola.dbarreto.com.br/api/

📝 Integração continua

A integração continua foi feita usando o serviço do https://buddy.works/ . Toda vez que acontece um push na branch 'master', os passos a seguir são executados:

os testes são rodados.
a ultima versão do repositório é baixada.
acontece o Build e Deploy na api hospedada no endereço http://novaescola.dbarreto.com.br/api/.
notificação por email.

Caso algum passo falhe, o pipeline é interrompido

📝 Licença

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

Made with ♥ by Daniel Barreto 👋 Get in touch!