Cortex Project

Overview

Welcome to the Cortex Project, a microfrontend-based application designed to showcase a modular approach to web development. This project is structured using Git submodules, allowing each segment of the application to be developed and maintained independently.

Modules

The project is divided into several key modules:

Navigation: The module responsible for the navigation aspects of the application.
Host: The main hosting module that integrates all microfrontends.
Utils/Tools: A collection of development tools and utilities to aid in the development process.

Getting Started

To get started with the Cortex Project, follow these steps:

Prerequisites

Ensure you have the following installed:

Git
[Any other prerequisites specific to your project]

Clone the Repository

git clone --recurse-submodules https://github.com/EdSpurrier/Cortex.git

Cloning submodules if you have already Cloned the repository

git submodule update --init

This command clones the main repository and all its submodules.

Navigating the Repository

After cloning, you'll find the following structure:

Modules/Navigation: Contains the Navigation microfrontend.
Host: The main Host module integrating all microfrontends.
Utils/Tools: Various development tools and utilities.

Running the Project

[Provide instructions on how to run the project, including how to initialize and start each module if needed.]

Contributing

We welcome contributions to the Cortex Project! If you're interested in contributing, please read our CONTRIBUTING.md file for guidelines on how to get started.

License

[Specify the license under which your project is made available.]

Remember to replace placeholder links and texts with actual information relevant to your project, such as installation and running instructions, contribution guidelines, and license details.

EdSpurrier / Cortex