Orama UI Monorepo

Welcome to the Orama UI Monorepo, a unified codebase for building, sharing, and maintaining UI components and utilities, powered by Turborepo.

🚀 Get Started

To set up the project locally, clone this repository and then:

1. Install dependencies:

   pnpm install

2. Run the development servers:

   pnpm dev

   This will start all apps in the apps/ directory.

🗂️ Monorepo Structure

• apps/web: Main Next.js web application with component showcases.
• apps/demo-next: Example Next.js app using Orama UI.
• packages/ui: Shared React component library.
• packages/eslint-config: Shared ESLint configuration.
• packages/typescript-config: Shared TypeScript configuration.
• packages/tailwind-config: Shared Tailwind CSS configuration.

All packages and apps use TypeScript for type safety.

🛠️ Building the UI Package

The ui package compiles React components and utilities into the dist directory. Next.js apps in this monorepo consume these components to showcase use cases and custom themes.

To build the UI package:

cd packages/ui
pnpm build

👉 See the ui package README for detailed usage, documentation, and available components.

🤝 Contributing

We welcome contributions! To get started:

1. Fork the repository and create a new branch:

   git checkout -b feature/your-feature

2. Make your changes and ensure code quality:

   • Run pnpm lint to check for lint errors.
   • Run pnpm format to auto-format code.
   • Add or update tests as needed.

3. Commit and push your changes:

   git commit -m "feat: add your feature"
   git push origin feature/your-feature

4. Open a Pull Request on GitHub and describe your changes.

🧰 Utilities

• Tailwind CSS — Utility-first CSS framework
• TypeScript — Static type checking
• ESLint — Code linting
• Prettier — Code formatting
• Turborepo — Monorepo tooling

---

Feel free to open issues or discussions for questions, suggestions, or feedback!