Code Monkey home page Code Monkey logo

boardlist-back's Introduction

Board Task Back

Este projeto é o backend do exercicio de criar um Boad Tasks feito para o curso do Rubens Flinco da escola DNC

Table of Contents

Tecnologias utilizadas

  • Nodejs
  • Express
  • Swagger
  • DotEnv
  • Mongoose
  • MongoDB
  • Cors

Iniciando este projeto

  1. Primeiro você precisa colocar este repositório em seu computador.
  2. Voce precisa copiar o rquivo Exemplo.env que está na raiz do projeto e renomeá-lo para .env para que as variáveis de ambiente sejam definidas.
  3. Depois é só executar o compando $ npm install no terminal na pasta raiz do projeto.
  4. Em seguida, você pode executar o comando $ npm run dev no terminal na pasta raiz do projeto, para iniciar o servidor back-end.
  5. Depois entre na documentação da API é só acessar em seu navegador o endereço http://localhost:4000/

Configuração do Projeto

Script

Primeiro item adicionado foi o script

"scripts": {
    "dev": "npx nodemon ./bin/www" 
  },

A inserção deste script serve para rodar o projeto (como o npm start), mas o nodemon facilita o desenvolvimento do projeto pois ele atualiza automaticamente as autreçaões inseirdas no projeto sem precisarmos ficar reinicializando toda hora o projeto manualmente.

Swagger

Realizo a instação do Swagger Fará a documentação automática da API

$ npm install swagger-autogen swagger-ui-express

Mongoose

O Mongoose será a biblioteca que de fato faz a conexão com o banco de dados:

$ npm install mongoose mongoose-to-swagger

O Mongoose-to-swagger faz a tradução dos esquemas de bancos de dados pro swagger

Cors

O Cors serve para evitar problemas de cors entre o frontend e o back end

$ npm install cors

Depois importamos o Cors no App.js

const cors = require('cors');

//[...]

app.use(cors());

Dotenv

Serve para usarmos o arquivo "*.env" que é um arquivo de variáveis de ambiente.

$ npm install dotenv

Para configura esta dependencia, vamos ao App.js

const app = express();

require('dotenv').config();

Depois de fazer esta configuração, já é possivel criar um arquivo ".env" e inserir as variaveis de ambiente

Para chamar uma variável de ambiente que está no arquivo Dotenv, vamos ao arquivo que queremos chamar e usar o seguinte comando.

//este comando foi inserido no users.js
router.get("/", function (req, res, next) {
  console.log("var: ", process.env.TEST); //este comando é o responsável por processar a variavel de ambiente.
  res.send("respond with a resource ");
});

boardlist-back's People

Contributors

xtirian avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.