Skip to content

Latest commit

 

History

History
100 lines (69 loc) · 3.62 KB

README.md

File metadata and controls

100 lines (69 loc) · 3.62 KB
Raw

Your Image Description

Turborepo Badge Tailwind CSS Badge TypeScript Badge ESLint Badge Prettier Badge

Welcome to the official starter kit for Turborepo, the high-speed monorepo management tool that's about to turbocharge your development process!

🌟 Getting Started is a Breeze!

Ready to hit the ground running? Fire up your terminal and let's get those engines revving:

npx create-turbo@latest

📦 What’s in the Box?

Dive into a world of efficiency with these pre-configured goodies:

🌐 Apps and Packages Galore!

  • app: a sleek Next.js app for your web app.
  • contacts-dashboard-app: a sleek React contact management app that uses browser's storage to save data.
  • dynamic-graph: a modern and responsive React data visualizer via a graph; that uses browser's storage to save the user's search history and sharable results via links.
  • ui: a shared React component library powering all the apps.
  • tailwind-config: a shared Tailwind CSS configuration for consistent styling across apps and libraries.
  • eslint-config-custom: Keep your code clean with custom eslint configurations, including eslint-config-next and eslint-config-prettier.
  • tsconfig: Centralized tsconfig.jsons for consistent TypeScript configurations across the monorepo.

Psst... TypeScript is our language of choice here for that extra type safety!

🔧 Handy Utilities at Your Fingertips

  • TypeScript: For ironclad type checking.
  • ESLint: To keep your code squeaky clean.
  • Prettier: Because who doesn't love beautifully formatted code?

🏗️ Build Instructions

To construct all apps and packages in one fell swoop:

cd my-turborepo
pnpm build

🎨 Develop with Joy

Kickstart your development environment with:

cd my-turborepo
pnpm dev

⚡ Remote Caching for Lightning-Fast Builds

Leverage Remote Caching to share cache artifacts across machines. Perfect for team collaborations and CI/CD pipelines.

Initially set to local cache, you can switch to Remote Caching with a Vercel account:

cd my-turborepo
npx turbo login

Authenticate the Turborepo CLI with your Vercel account, then:

npx turbo link

📚 Learn More and Stay Turbocharged!

Fuel your knowledge about Turborepo with these resources:

📝 TO-DO:

  • Add bootstrap-config styling?

Contributions: