Coder Social home page Coder Social logo

pedroyremolo / transfer-api Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 2.0 217 KB

API criada com o propósito de prover o gerenciamento das transferências entre contas de um banco digital.

License: MIT License

Dockerfile 0.72% Go 98.39% Makefile 0.88%
golang rest-api ddd hexagonal-architecture mongodb go-dockerfile docker-compose

transfer-api's Introduction

Transfer API

API criada com o propósito de prover o gerenciamento das transferências entre contas de um banco digital.

A arquitetura da aplicação visa aplicar os conceitos do Domain-Driver Design, Eric Evans, e da Hexagonal Architecture, de Alistair Cockburn.

Requerimentos / Dependências

A aplicação, feita em Go, depende do próprio módulo, e de pelo menos uma instância MongoDB.

A mesma é distribuída através de containers Docker.

Todas as dependências de pacotes estão relacionadas em go.mod, que é utilizado para gerenciamento das mesmas.

Para baixa-las, com Go instalado na sua máquina:

$ go mod download

Como usar

A aplicação possui distribuição via Docker, e possui um arquivo docker-compose, sendo este o modo mais fácil de executa-la localmente.

Além disso, possui uma especificação OpenAPI 3 através do arquivo openapi.yml.

A mesma é gerenciada via variáveis de ambiente, segue abaixo a tabela:

Nome Descrição
APP_PORT Porta a ser escutada pela aplicação para novas requisições
APP_LOG_LEVEL Nível de log estruturado da aplicação
APP_DOCUMENT_DB_HOST Host da instância do MongoDB
APP_DOCUMENT_DB_PORT Porta da instância do MongoDB
APP_DOCUMENT_DB_USERNAME Usuário da instância do MongoDB
APP_DOCUMENT_DB_SECRET Senha da instância do MongoDB
APP_DOCUMENT_DB_NAME Nome do banco default da instância do MongoDB
APP_JWT_GATEKEEPER_SECRET Segredo de geração do token JWT
APP_JWT_GATEKEEPER_ISSUER Emissor do token JWT

Docker-Compose

Para executar via docker-compose

$ docker-compose up --build -d

Licença

A aplicação está sob a licença MIT

Créditos

Agradecimento em especial a todos os autores das bibliotecas de terceiros utilizadas, e citadas acima.

E aos conteúdos, e seus autores, em que me baseei para a construção dessa aplicação:

Videos

Artigos

transfer-api's People

Contributors

pedroyremolo avatar

Stargazers

 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.