Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.9 KB

README.md

File metadata and controls

45 lines (34 loc) · 1.9 KB

Unified Turborepo Essential

Unified Turborepo Essential, An Essential Template to get started with Turborepo application with all the essentials included...

Features

  • ✨ Famework: Next.js - The React Framework
  • 📦 Bundler: Turbopack - The universal bundler for web
  • 🚀 Styling: Tailwind CSS - Utility-first CSS framework
  • 💻 Language: TypeScript - Typed superset of JavaScript
  • 🧹 Linting and Formatting: Biome.js - Fast and customizable linter and formatter
  • 🎨 Themes: next-themes - Easy theming for React.js.
  • 💄 Icons: lucide-react - A comprehensive set of icons for React.js
  • ⚙️ Build: Github Actions - Automated workflows for CI/CD
  • 🛠 Commit: Husky - Git hooks made easy
  • 📦 Package: pnpm - Fast, disk space efficient package manager

Project Structure

  • apps/: Source code directory
    • web/: Web application
  • packages/: Packages directory
    • ui/: UI components
    • tailwind-config/: Tailwind CSS configuration
    • lib/: Helpers, utilities, and configs
    • ts-config/: TypeScript configuration

Getting Started

  1. Clone the repository
  2. Install dependencies: pnpm install
  3. Run the development server: pnpm run dev
  4. Open http://localhost:5173 in your browser

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature/your-feature-name
  5. Submit a pull request

For major changes, please open an issue first to discuss what you would like to change.