https://github.com/backbase/local-backend-setup
https://github.com/backbase/local-backend-setup
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/backbase/local-backend-setup
- Owner: Backbase
- License: other
- Created: 2023-03-27T13:42:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-27T06:35:21.000Z (9 months ago)
- Last Synced: 2025-07-29T17:06:03.224Z (6 months ago)
- Language: Java
- Size: 2.04 MB
- Stars: 4
- Watchers: 11
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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](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](http://localhost:8761) in your web browser. Additionally, you can import the [Postman collection](test/postman/HealthCheck_Local-Backend-Environment.postman_collection.json) to perform a more comprehensive health check on your environment using Postman.
For more information, see [Set up Backbase local environment](https://github.com/backbase/local-backend-setup/tree/main/development/docker-compose#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](https://github.com/baas-devops-reference?q=template&type=all&sort=). 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](https://backbase.io/developers/documentation/backend-devkit/latest/development/create-a-service/).
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](https://github.com/baas-devops-reference).
## 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`.