Skip to content

README.md

Latest commit

 

History

History
122 lines (80 loc) · 3.38 KB

README.md

File metadata and controls

122 lines (80 loc) · 3.38 KB

Initia Frontend Dashboard Template (Monorepo)

A production-ready, open-source frontend dashboard monorepo built with React + TypeScript + Vite, designed to work seamlessly with Initia-generated backends.

This monorepo contains:

  • 🧑‍💻 User App: User-facing dashboard and features
  • 👨‍💼 Admin App: System administration and management
  • 📦 Shared Package: Reusable components, utilities, and types

Perfect for:

  • 🚀 Startup MVPs with separate user and admin portals
  • 🧑‍💼 Multi-tenant applications
  • 🧪 Scalable projects requiring code reusability

🏗️ Monorepo Structure

packages/
├── user-app/          # User-facing application (port 5173)
├── admin-app/         # Admin panel (port 5174)
└── shared/            # Shared code (components, utils, types, API)

⚡ Quick Start

# Install pnpm if not already installed
npm install -g pnpm

# Install dependencies
pnpm install

# Run user app
pnpm dev:user

# Run admin app (in another terminal)
pnpm dev:admin

# Build both apps
pnpm build

⭐ Support the Project (Important)

This project is free and open-source.
If it is saving you time, helping your project, or you plan to use it commercially:

👉 Please support us:

  1. ⭐ Star this repository
  2. ⭐ Star the GitHub organization
  3. 💖 Donate to sustain development and provide you with more

Your support directly funds:

  • New templates
  • Better documentation
  • Faster fixes & features
  • Long-term maintenance
  • Community support
  • Execution of our roadmap

Open-source survives on users who give back.

📚 Documentation – Choose Your Path

We provide two separate guides, depending on your background:

👩‍💼 Non-Technical / Product-Focused Users

➡️ Start here
📄 docs/START_NON_TECHNICAL.md

For founders, students, PMs, and new or non developers who want to run, configure, and deploy the dashboard with minimal coding.

👨‍💻 Technical Users / Developers

➡️ Start here
📄 docs/START_TECHNICAL.md

For developers who want to extend, customize, and maintain the codebase professionally.

🧰 Tech Stack (Quick Overview)

📄 License

MIT License – free for personal and commercial use.
Attribution and support are appreciated.

🧠 Maintainers