Giter VIP home page Giter VIP logo

aline-card-microservice's Introduction

Aline

Microservice Template


NOTE: This repository is not to be developed on. Create another repository and use this as a template.

Start developing your microservice here.



Creating Your Own Repository


  1. Create a repository under the Aline Financial organization.
  2. Select Aline-Financial/aline-microservice-template as the repository template.
  3. Clone your repository onto your machine.
  4. In the projects root, run git submodule init. A core/ directory should now be created.
  5. Run git submodule update to pull down the most recent core. (Note: This will clone the Core Repository that is automatically checked out to a hashed branch.)
  6. Rename main module to be your microservice. (ex. usermicroservice)
  7. Update CI/CD files to match project.
  8. Run mvn test to make sure your project builds!

If you get a success, you're all set. Start creating your microservice.




Managing the core


The core is a shared-code repository that contains classes such as:

  • Models
  • Data-Transfer Objects (DTO)
  • Repositories
  • Custom Exceptions
  • Etc...

Before you put code in the core, make sure to consider the following:

  • "Is there already code in the core that already solves my problem?"
  • "Will there be circular dependency between the core and the application module?"
  • "Will other microservices need to use this code?"

Carefully consider these questions.

Create a new branch in the core that matches the current feature branch you are working on in the main module.

When pushing up, make sure to run git status to make sure core changes do not need to be committed.

PUSH THE CORE FIRST

Once the core change are pushed into the repository, push your whole repository from the parent. The core branch will update.


Included Tools & Plugins:

  • Maven
  • SonarQube
  • JaCoCo
  • Jenkins (Jenkinsfile)
  • Docker (Dockerfile)
  • CloudFormation Template (ecs-aws.yaml)
  • Swagger 2
  • Swagger-UI (Access it by going to http://localhost:{port}/swagger-ui/)

For more information on tools & plugins included in this project, look at your repo's pom.xml.



Team Aline


aline-card-microservice's People

Contributors

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