Tabela de conteúdos

• Sobre o projeto
• Funcionalidades
• Como executar o projeto
  • Pré-requisitos
  • Rodando a aplicação web (Frontend)
• Autor
• Licença

💻 Sobre o projeto

API Agenda - api para cadastro de pessoas e endereços.

---

⚙️ Funcionalidades

• Cadastro de pessoas, com campos:
  • nome
  • tipo da pessoa
  • cep ou cnpj
  • telefone
  • email
• Cadastro de endereços para a pessoa, com campos:
  • cep
  • logradouro
  • bairro
  • localidade
  • uf
  • número
  • tipo endereço

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js e PostgreSQL.

🧭 Rodando o Backend (servidor)

# Clone este repositório
$ git clone https://github.com/RobertoKlann/api-pessoa-nodejs.git

# Vá para a pasta do projeto
$ cd api-pessoa-nodejs

# Instale as dependências
$ npm install

# Vá para a pasta database e edite o arquivo index.js com as suas configurações do Banco de Dados
$ cd src/database

# Execute o script de criação das tabelas do BD. OBS(Não pode existir uma tabela tbpessoa e tbendereco, se existir o SQL vai dar erro)
$ node src/database/createTables.js

# Execute a aplicação em modo de desenvolvimento
$ node server.js

# O servidor inciará na porta:5000

---

🦸 Autor

Roberto Oswaldo Klann

📝 Licença

Este projeto esta sobe a licença MIT.