Local backend setup

This repository has the required files for backend developers to create a basic local environment. Instructions on how to set up this environment are found under development.

Quick start

Set up a Docker local environment on your laptop by running these commands in the terminal:

1. Clone the repository:

   git clone git@github.com:backbase/local-backend-setup.git
   

2. Switch to the Docker Compose directory:

   cd local-backend-setup/development/docker-compose
   

3. Start the health checks and ensure that all services are running:

   docker compose --profile=bootstrap up
   

   Once all the required services have started, you can view the health check results in your terminal. To check the status of the services, open the Registry in your web browser. Additionally, you can import the Postman collection to perform a more comprehensive health check on your environment using Postman.
    
   For more information, see Set up Backbase local environment.

Create a new service

NB: EMU account required to access (https://github.com/baas-devops-reference)

To create custom services in the Backbase ecosystem, Backbase recommends using ModelBank templates. If you don't have an EMU account, you can find detailed instructions on creating a service using the service SDK (core-service-archetype) in the create a service guidelines.

Use these guidelines to develop your own service, and use the Backbase local environment to test and run your code.

For more information, see ModelBank organization.

Release Policy

We release this repository after every Backbase Breaking Changes release. Each release is compatible with all the Backbase versions until its next LTS version. For example, with the 2022.03 release, you can use any Backbase version Higher than 2022.03 up to 2023.09-LTS.