⚜️ backend-phonebook

Esse projeto e uma API de uma agenda telefonica. 📖

Heroku • Swagger • Node • Docker-compose • Postman • Tecnologias • Autor

Heroku

O projeto esta disponivel online no Heroko 😄

Swagger

A documentacao da api esta disponivel online Swagger 📃

Node

Pré-requisitos

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

E um banco relacional como MySQL, MariaDB, SQLite, PostgreSQL, Redshift,MSSQL e Snowflake, que sao suportadas pelo ORM sequelize

A conguracao de conexao com o banco devem estar no arquivo .env

Além disso é bom ter um editor para trabalhar com o código como VSCode

---

Rodando com Node

# Clone este repositório
$ git clone git@github.com:HigorAnjos/backend-phonebook.git

# Acesse a pasta do projeto no terminal/cmd
$ cd backend-phonebook

# Instale as dependências
$ npm install

# Popule o banco de dados
$ npm run db:init

# iniciar o projeto
$ npm start

A aplicação estara disponivel em http://localhost:3001/

A documentacao estara disponivel em http://localhost:3001/docs/

---

Docker-Compose

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Docker, Docker Compose.

Rodando com o doker-compose 🐋

# Clone este repositório
$ git clone git@github.com:HigorAnjos/backend-phonebook.git

# Rodar o docker-compose
$ docker-compose up -d

# Acessar a aplicação docker
$ docker exec -it phonebook_node bash

# Instale as dependências
$ npm install

# Popule o banco de dados
$ npm run db:init

# Rodar o projeto
$ npm start

A aplicação estara disponivel em http://localhost:3001

A documentacao estara disponivel em http://localhost:3001/docs/

Parar o container

$ docker-compose down

---

Postman

Download dos endpoints

Tecnologias

🛠️ As seguintes ferramentas foram usadas na construção do projeto:

• Git
• JavaScript
• JWT 🔐
• Node
• Expressjs
• Jest
• Supertest
• Eslint 💄
• Sequelize
• Docker-Compose 🐋
• Editor Config
• Nodemoon 🌙

Voce pode verificar todas ferramentas no arquivo package.json, em dependencies e devDependencies.

Autor

Made with 💜 by Higor Anjos 👋