Code Monkey home page Code Monkey logo

nestjs-solid-event-driven's Introduction

Logo Bankme

API Bankme

Sumário

👉 O que é?

API utilizada para gestão e controle de operações de crédito realizadas pelos Minibancos operantes da Bankme.

Além disso, expõe informações para todo o ecossistema Bankme, como por exemplo: informações de autenticação, operações, minibancos e recebíveis.

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

  • Instalação e configuração do NodeJS;
  • Instalação e configuração do Docker;
  • VSCode e os plugins necessários para rodar o projeto;
  • Conhecimento prévio de NestJS;
  • Conhecimento de CI/CD com GitHub Actions;
  • Testes automatizados de software;

🚀 Instalação

Este projeto utiliza o yarn como gerenciador de pacotes.

Primeiro, deve-se instalar os depêndencias, para isso iremos rodar no terminal, dentro da pasta do nosso projeto, um dos seguintes comandos:

$ yarn install

ou

$ yarn

O próximo passo é criar nosso banco de dados local, esse processo é facilitado pelo nosso arquivo docker-compose.local que gera nosso container dentro do docker completamente pronto para nossa API se conectar com a mesma.

Mas antes precisaremos criar uma nova rede de conexão, para isso, basta rodar o seguinte comando:

$ docker network create bankme-dev

Logo após, devemos criar um arquivo com o nome ".env" na root do nosso projeto e adicionar as chaves necessárias para a criação do nosso banco de dados. Solicite as chaves para alguém do time.

IMPORTANTE: Lembre-se de verificar se sua DATABASE_URL está apontando para o seu banco local, para evitar acidentes no nosso banco de DEV, ou até mesmo no nosso banco de PROD!

Depois de criada nossa nova conexão, iremos rodar o comando responsável pela execução do nosso arquivo docker-compose, cujo o qual ira criar nosso container com nosso banco de dados PostgreSQL:

$ yarn db:start-local

Caso queira saber mais sobre o comando, acesse o arquivo em que o mesmo está descrito package.json.

Com nosso container criado, vamos aplicar as nossas migrations já criadas em nosso banco local:

$ yarn migrate:dev

Se após o comando terminar o nosso banco de dados continuar vazio (sem dados em nossas tabelas), basta rodar nosso seed, script utilizado para popular o banco de dados:

yarn db:reset

Vamos agora gerar a modelagem dos nossos dados utilizando o Prisma:

$ yarn prisma generate

Após isso nosso banco de dados estará criado, modelado e populado!

Após todos estes passos concluídos podemos rodar nosso projeto utilizando o seguinte comando:

$ yarn dev

Executando testes

A melhor maneira de se familiarizar com um projeto é através dos seus testes!

Para executar os testes do projeto, use o comando:

$ yarn test

Executando lint

$ yarn lint

Buildando o projeto

$ yarn build

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:


Keven Lucas

João Vitor Cunha

Gabriel Ruivo

João Marcolino

Luis Eduardo Luz

João Augusto

Diogo Lara

Diogo Cezar

⬆ Voltar ao topo

nestjs-solid-event-driven's People

Contributors

gabrielruivo 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.