MachaOn-SL-OCI-1

The MachaOn-SL-OCI-1 project is a focused implementation of the Macha framework, tailored to provide developers with a clear, structured starting point for building modular, deployable applications. Acting as a seed-level project, it offers a scalable blueprint and reference implementation that combines Core and Application modules seamlessly, leveraging the Machanism ecosystem's modular principles.

This project is designed to demonstrate both the flexibility and simplicity of the Macha framework, ensuring developers and teams can create, validate, and ship applications faster while adhering to clean architecture principles.

Overview

This Oracle Cloud Infrastructure (OCI) application provides a seamless user experience by integrating multiple components across front-end and back-end systems. The application features a browser-based front-end hosted on Object Storage that communicates with a Frontend Gateway, which handles HTTPS requests and serves static assets from OCI Object Storage buckets. API requests are routed through an API Gateway to six serverless functions (login, registration, products, user, order, and authorizer functions) within the OCI ecosystem. These functions process business logic and interact securely with an external Commercetools API to handle tasks such as user authentication, product retrieval, or order processing. The architecture ensures scalability, flexibility, and efficient integration between cloud-native services.

Project Structure

The structure of MachaOn-SL-OCI-1 is built to maintain modularity, readability, and ease of integration. The following breakdown highlights its key components:

Getting Started

To develop an OCI application with MachaOn-SL-OCI-1, follow these general steps:

  1. Clone the Repository:
    Begin by cloning the MachaOn-SL-OCI-1 repository to your local machine:

    git svn clone https://svn.code.sf.net/p/macha/code/trunk/machaon/faas/oci/machaon-sl-oci-1 machaon-sl-oci-1

    For detailed guidance on working with git-svn, visit: Prefer Working with Git? Use git-svn.

  2. Explore Child Modules:
    This project is structured into multiple child modules, each dedicated to specific functionalities like front-end and back-end development. Navigate to the respective child module directories to find detailed instructions and configuration steps relevant to that part of the application.

  3. General Setup:
    Review the project documentation and ensure all prerequisites (e.g., OCI CLI, Docker, or environment variables) are installed or configured before proceeding with development or deployment.

For specific details related to front-end or back-end setup, refer to their respective child module documentation. This modular approach allows you to focus on individual components of the application as needed.