06. INTERFACE REQUIREMENTS - riyadmazari/ie-bank-infra GitHub Wiki

INTERFACE REQUIREMENTS

Backend interface requirements:

  • The backend component should expose well-defined API endpoints as specified in 'routes.py' to allow communication with the frontend.
  • The API endpoints should follow RESTful principles or any other defined conventions.
  • The backend should provide a reliable connection to the database, as defined in 'models.py,' to ensure data integrity and availability.
  • Integration with the frontend should be seamless, with 'Skull.vue' handling backend connection, API calls, and data retrieval.
  • The 'requirements.txt' file should specify the necessary Python packages and dependencies for the backend, ensuring compatibility and reliability.

Frontend Interface Requirements:

  • The frontend should interact with the backend through API calls to retrieve and display account-related information and other relevant data.
  • Vue.js components, such as 'AppAccounts.vue' and 'HomePage.vue,' should communicate effectively with each other and with the backend.
  • The frontend should be configured to use different environment-specific settings as specified in '.env.development' and '.env.uat' files for development and UAT environments.
  • Inside the Accounts page, users are able to navigate the different accounts already created; users are able to create a new accounts entering the information in the input fields; users can view their account balance, account status, account ID; users are able to edit and delete respectively their desired account and make transactions.

Infrastructure Interface Requirements:

  • The infrastructure component should provision and configure Azure resources as specified in 'ie-bank-infra.yml.'
  • Azure resources, such as App Service instances and databases, should be provisioned with the configurations defined in 'app-service.bicep' and parameter files.
  • The infrastructure should support the deployment of the backend and frontend components, ensuring they have the necessary connectivity and resources.