Skip to content

README.md

Latest commit

 

History

History
60 lines (52 loc) · 2.5 KB

README.md

File metadata and controls

60 lines (52 loc) · 2.5 KB

🌐 Micro Frontend Turborepo Starter

Welcome to the Micro Frontend Turborepo Starter!
This project demonstrates a monorepo setup for micro frontends using Turborepo. 🚀

🏗️ Project Overview

This repository follows a monorepo architecture to manage multiple micro frontends efficiently. It includes:

  • Applications (apps/): Independent frontend apps.
  • Shared Packages (packages/): Reusable configurations and components.

📦 Shared Packages

To ensure consistency across micro frontends, this repo includes the following reusable packages:

  • eslint-config 🧹 – Standardised ESLint rules for consistent code style.
  • tailwind-config 🎨 – Shared Tailwind CSS setup for a unified design system.
  • typescript-config 📜 – Common TypeScript settings for better maintainability.
  • ui 🏗️ – A component library with reusable UI elements.

🌍 Deployments

This project is hosted on Vercel with automatic deployments:

🌟 Tech Stack

  • 📦 Monorepo Structure – Efficiently manage multiple micro frontends.
  • 🔗 Micro Frontend Architecture – Independent development and deployment of frontend modules.
  • ⚡ Turborepo Integration – Speeds up builds and improves performance.
  • 🚀 Vercel Hosting – Automatic and scalable deployments.
  • 🎨 Shared Configurations – Standardised ESLint, Tailwind, and TypeScript settings.
  • 🖥️ Reusable UI Library – Prebuilt components for a consistent UI.
  • 🚀 TypeScript – Strongly typed JavaScript.
  • 🌍 React – UI library for building modular frontends. 📦 Tailwind CSS – Utility-first styling framework.

🚀 Getting Started

Clone the repository:

git clone https://github.com/imevanc/microfrontends-monorepo.git

Navigate to the project directory:

cd microfrontends-monorepo

Install dependencies:

pnpm install

Start the development server:

pnpm run dev

The host application will be available at http://localhost:3000 and the remote at http://localhost:3001.

📄 License

This project is licensed under the MIT License.

🤝 Contributing

Contributions are welcome! Open an issue or submit a pull request.

📧 Contact

For questions or suggestions, open an issue in this repository.
Enjoy building with the Micro Frontend Turborepo Starter! 🚀🎉