The Architecture Refactoring Helper is an application which aims to help find suitable migration approaches to microservices architecture.

• Docker
• Docker-compose

1. Navigate to "{RepositoryFolder}" via Console
2. Run "docker-compose build" (only needed on first startup or if code changed were made)
3. Run "docker-compose up"

After starting the docker containers the API can be reached at:

• "https://localhost:8080/api/v1" or
• "https://localhost:5000/api/v1"

and the User interface at:

• "https://localhost:8080/" or
• "https://localhost:9000/"

It might be necessary to change the production URL of the API inside the user interface project. This can be done in the "{RepositoryFolder}/UI/src/environments/environment.prod.ts" file.

• .NET 6 SDK - if running without Docker
• Docker - if running in Docker

• Running through IDE
  1. Open "ArchitectureRefactoringHelper.sln" in "{RepositoryFolder}/ArchitectureRefactoringHelper" Folder
  2. Run "Repository" Project
• Running through Console
  1. Navigate to "{RepositoryFolder}/ArchitectureRefactoringHelper/Repository"
  2. On first startup run "dotnet restore"
  3. Run "dotnet run"
• Running in Docker container
  1. Navigate to "{RepositoryFolder}/ArchitectureRefactoringHelper/Repository"
  2. Run "docker build -t {ImageTag} ."
  3. Run "docker run -p 5000:5000 {ImageTag}"

After starting the app the API will run on:

• "https://localhost:7262/api/v1"

and the swagger UI can be reached at:

• "https://localhost:7262/swagger/index.html"

After starting docker container the API can reached at:

• "https://localhost:8080/api/v1" or
• "https://localhost:5000/api/v1"

Swagger UI is not active when running the application in docker

• node.js - if running without Docker
• Angular CLI - if running without Docker
• Docker - if running in Docker

• Running through WebStorm
  1. Open "{RepositoryFolder}/UI" Folder
  2. Run application
• Running through Console
  1. Navigate to "{RepositoryFolder}/UI"
  2. On first startup run "npm install"
  3. Run "ng serve"
• Running in Docker container
  1. Navigate to "{RepositoryFolder}/UI"
  2. Run "docker build -t {ImageTag} ."
  3. Run "docker run -p 9000:9000 {ImageTag}"

After starting the app the user interface can be reached on:

• "https://localhost:4200"

After starting docker container the user interface can be reached at:

• "https://localhost:8080/" or
• "https://localhost:9000/"

The ng-openapi-gen NPM module enables us to generate angular services and models based on a OpenApi 3 specification. As an input, it takes either the swagger.json file in the "{RepositoryFolder}/Repository" folder.

For more info see: https://github.com/cyclosproject/ng-openapi-gen

• Open console of choice
• Navigate to "{RepositoryFolder}/UI"
• Run "npm run ng-openapi-gen"

The swagger.json will be generated at each startup of the back-end application. This is not the case when using the existing dockerfiles.