Skip to content

Project Structure

biscuitWizard edited this page Apr 5, 2024 · 3 revisions

= Project Structure =

This page provides an overview of the project's directory structure and its main components. Understanding this structure will help with navigating and contributing to the project efficiently.

== Source Code (/src) ==

The /src directory contains the main source code of the project. It is organized into subdirectories for different aspects of the application.

=== Views (/src/views) ===

The /src/views directory contains Vue components structured as pages, following the IonPage pattern. Each Vue file is named after the page it represents, following the <X>Page.vue naming convention. These pages are rendered based on routes defined in the /src/router directory.

==== Router (/src/router) ====

The /src/router folder houses the routing engine, which maps URLs to the pages rendered by the application. This setup facilitates the navigation between different views within the app.

=== Stores (/src/stores) ===

For state management, the /src/stores directory contains Vuex stores, leveraging Pinia for managing persistent information across the app. Pinia provides a modular approach to state management in Vue applications, offering features like improved type support and composition API integration.

=== Components (/src/components) ===

Reusable Vue components are located in /src/components. These components are designed to be utilized across various views, promoting DRY (Don't Repeat Yourself) principles and consistency throughout the application's UI.

== Lambda Functions (/lambda) ==

The /lambda folder is designated for lambda functions that the project utilizes. Each subfolder within /lambda represents an individual function. For more details on lambda functions and their usage within our project, see the Lambda Functions Wiki Page.

For more information on Pinia and how it's used within our Vuex stores, visit the official Pinia documentation.

== Navigation ==

== See Also ==

Clone this wiki locally