Skip to content

project_structure

jkutkut edited this page Jun 11, 2023 · 2 revisions
stateDiagram-v2
  [*] --> setup_service
  setup_service --> EatUp

  state setup_service {
    state back:private {
      %%layout_editor
      %%product_editor
      services_handler
      installer
    }
    state front:public {
      setup_web
      staff_web
    }
  }

  state EatUp {
    state server_service {
      state db:private {
        [*] --> sql_database
      }
      state server:public {
        [*] --> file_server
        [*] --> rest_api
      }
    }
    
    state order_service {
        state android_app {
            query_menu
            generate_orders
        }
    }

    state staff_service {
      client_manager
      bill_generator
    }

    %%state kitchen_service {
    %%  orders_queue
    %%}

    server_service --> order_service
    %%server_service --> kitchen_service
    server_service --> staff_service
  }
Loading

Project Structure

  • All the services of the project are in the container EatUp.

  • Inside each service (the containers with name *_service), you can find all the microservices that compose it.

    • Example: android_app in the order_service.
    • If the microservice name contains a :XXXXX suffix, it represents the public visibility of the service.
      • Example: server:public can be used by all services outside server_service.
      • Example: db:private is the private database service that can not be used outside of its service.
      • This notation is optional.
  • Inside each microservice, you can find features.

    • Example: file_server is a feature of the server microservice inside of the server_service.
    • Note: If a service is not fully defined, the features may appear where the microservices should be.
  • Note: Keep in mind this project structure definition allows to visualize the relation between microservices and the features. The actual implementation does not correlate with this structure.
    • Example: The android_app may contain more than one service.

Clone this wiki locally