Giter VIP home page Giter VIP logo

nodejs-ts-boilerplate's Introduction

Nodejs Ts boilerplate

O que foi feito

Neste boilerplate para um back-end dockerizado utilizando modelagem de dados através do sequelize etypescript.

Como usar template e criar repositório:

GIF

⚙️ Como rodar o projeto

Configurações mínimas para execução do projeto:

  • Sistema Operacional Distribuição Unix

  • Node versão 16.14.0 LTS

  • Docker

  • Docker-compose versão >=1.29.2

    Com Docker:

    ⚠️ Antes de começar, seu docker-compose precisa estar na versão 1.29 ou superior. Veja aqui ou na documentação como instalá-lo. No primeiro artigo, você pode substituir onde está com 1.26.0 por 1.29.2.

  • npm run docker:up na raiz do projeto;

  • docker exec -it app_backend bash;

  • npm run db:reset no container do backend;

Localmente:

  • npm install na raiz do projeto;
  • npm run dev;
  • npm run db:reset;

Necessita ter um banco de dados(MySql) instalado localmente

Scripts disponíveis

Além do comando npm run start, há outros scripts disponíveis que podem ser úteis durante o desenvolvimento:

  • npm run dev: Inicia o servidor local utilizando o ts-node-dev, que permite reiniciar automaticamente o servidor sempre que um arquivo é alterado.
  • npm run test:mocha: Executa todos os testes do projeto utilizando o Mocha.
  • npm run test:coverage: Executa os testes do projeto e gera um relatório de cobertura de código utilizando o Istanbul.
  • npm run db:reset: Apaga todas as tabelas do banco de dados, cria novamente a estrutura do banco e popula o banco com dados iniciais.
  • npm run docker:up: Inicia os containers Docker necessários para executar o projeto.
  • npm run docker:down: Encerra os containers Docker utilizados pelo projeto
📝 Dependências utilizadas
  • bcrypt
  • cors
  • dotenv
  • express
  • express-async-errors
  • jsonwebtoken
  • mysql2
  • sequelize
  • zod
  • chai
  • chai-http
  • eslint
  • eslint-config-airbnb-base
  • eslint-config-airbnb-typescript
  • eslint-plugin-import
  • eslint-plugin-mocha
  • eslint-plugin-sonarjs
  • mocha
  • nodemon
  • nyc
  • sequelize-cli
  • sinon
  • ts-node
  • ts-node-dev
  • typescript
Devs responsáveis

nodejs-ts-boilerplate's People

Contributors

murilo-mrs avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

nodejs-ts-boilerplate's Issues

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.