Skip to content

About

Base structure (initial structure) to start a backend project with nodeJS/Typescript.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Descrição do Projeto

Este projeto foi desenvolvido com o intuito de facilitar o desenvolvimento em NodeJS, este projeto contem uma estrutura base para começar um projeto Node.

Objetivo do Projeto

O objetivo do projeto é criar uma estrutura base em NodeJS atendendo aos seguintes requisitos:

  • Deve possuir uma estrutura route->controller->service.
  • Deve possuir validação das requisições usando o express-validator.
  • Deve possuir rotas de exemplo.
  • Deve possuir testes de exemplo.
  • Deve possuir logs.
  • Deve possuir linters vinculados ao projeto.

Tecnologias Utilizadas

As técnologias utilizadas foram NodeJS e NPM.

Bibliotecas utilizadas

  • Dependencias

    • express versão 4.17.1 ou superior.
    • body-parser versão 1.18.2 ou superior.
    • express-validator versão 6.3.0 ou superior.
    • winston versão 3.2.1 ou superior.
  • Dependencias de Desenvolvimento

    • chai versão 4.2.0 ou superior.
    • chai-http versão 4.3.0 ou superior.
    • chai-things versão 0.2.0 ou superior.
    • concurrently versão 5.0.0 ou superior.
    • eslint versão 6.7.2 ou superior.
    • eslint-config-airbnb-base versão 14.0.0 ou superior.
    • eslint-config-prettier versão 6.7.0 ou superior.
    • eslint-plugin-import versão 2.18.2 ou superior.
    • mocha versão 6.2.2 ou superior.
    • nodemon versão 2.0.1 ou superior.
    • prettier versão 1.19.1 ou superior.

Como instalar a aplicação

Basta apenas baixar o projeto, abrir a pasta local dele no terminal e digitar o comando npm install ou yarn install, que ele ira instalar todas as bibliotecas.

Como rodar a aplicação localmente

Para startar o projeto localmente você pode digitar o comando npm run dev no diretório do projeto.

Após isso ele irá abrir na porta 3002 no seu localhost, ou seja, basta apenas entrar em localhost:3002.

Desenvolvedor

Paulo Ricardo da Luz Júnior

About

Base structure (initial structure) to start a backend project with nodeJS/Typescript.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages