/testeAPI

Primary LanguageJavaScript

TesteAPI

Claravista

Objetivo

Desenvolver uma API para manipulação de dados de navegação em sites genericos.

Tech Stack

Back-end: Node Js, express, javascript, Mongoose.

Design pattern: MVC

Banco de dados: Não Relacional, MongoDB.

Como utilizar

  • Faça o clone para sua máquina
https://github.com/PauloHBLima/testeAPI.git
  • Instale todas as dependências
npm install
  • Crie uma conta no site abaixo para ter acesso ao banco de dados:
https://account.mongodb.com/account/login?signedOut=true
  • Depois da conta criada, siga esses passos:
- Create a Shared Cluster
- Connect (mongoDB drivers) - será gerado um link para conectar sua aplicação ao banco.
  • Vá até o arquivo .env.example e insira as configurações de autenticação
// Usuario de sua máquina (root padrão)
DB_USER=
// Nome que é configurado quando o banco foi criado no mongodb ATLAS
DB_PASS=
// Senha que é configurada quando o banco foi criado no mongodb ATLAS
  • Crie o a conexão com o banco de dados
mongoose.connect(link gerado para conectar ao banco)
  • Faça a inserção de valores padrão em seu banco de dados naModel
- tabela do banco de dados em Collections

npm start

Documentação da API via Postman

https://documenter.getpostman.com/view/22468594/2s83ziN4BJ

Tecnologias utilizadas

Desenvolvimento

"devDependencies": {
    "nodemon": "^2.0.20"
  }

Produção

"dependencies": {
    "bcryptjs": "^2.4.3",
    "body-parser": "^1.20.1",
    "cors": "^2.8.5",
    "dotenv": "^16.0.3",
    "express": "^4.18.1",
    "express-validator": "^6.14.2",
    "jsonwebtoken": "^8.5.1",
    "mongoose": "^6.6.5"
  },
  "devDependencies": {
    "nodemon": "^2.0.20"
  }

Muito Obrigado!