Skip to content

Latest commit

 

History

History
115 lines (89 loc) · 4.44 KB

README.md

File metadata and controls

115 lines (89 loc) · 4.44 KB
Raw

React Starter

🍱 Another React Starter using Bun, Vite, TypeScript, tailwindcss and daisyUI.

🐣 Features

  • 🍞 bun for a fast runtime and package manager.
  • ⚡️ vite for instant server start and lighting fast HMR.
  • 🏷️ TypeScript for a less frustrating & consistent experience.
  • 🏝️ TanStack Router for a fully type-safe React router.
  • 🏝️ TanStack Query for asynchronous state management.
  • 💄 tailwindcss for utility-first CSS.
  • 💄 daisyUI for tailwindcss components.
  • 🧱 storybook for building UIs in isolation.
  • 🧪 vitest for fast testing.
  • 🧪 Playwright for fast and reliable e2e testing.
  • 🧪 Mock Service Worker for client-agnostic API mocks.
  • 🩺 eslint for static analysis.
  • 🩺 Knip for finding dead code.
  • 🎨 prettier for formatting.
  • 🩺 lefthook for fast Git hooks management.
  • 👷 Turborepo for caching and task parallelization.
  • 👷 GitHub Actions for easy workflow automation.

🛠️ Usage

You can either use this template or deploy on Vercel or use tiged, by running the following command:

bunx tiged jimmy-guzman/react-starter

🏁 Getting Started

First install bun, by running the following command:

curl -fsSL https://bun.sh/install | bash

Now you can install dependencies, by running the following command:

bun install

Or if you already have bun installed you upgrade, by running the following command:

bun upgrade --stable

And to download new browsers for Playwright, run the following command:

bunx playwright install

And install Turborepo, run the following command:

bun install --global turbo

Then to run the development server, run the following command:

turbo dev

Your application will be available at http://localhost:5173/ ❤️

🧞 Available Tasks

Command Action
bun install Installs dependencies
turbo dev Starts local dev server at http://localhost:5173/
turbo build Build your production site to ./dist/
turbo preview Preview your build locally, before deploying
turbo test Unit tests your code with vitest
turbo e2e E2E tests your code with playwright
turbo lint Lints everything with eslint
turbo lint:fix Fixes lint errors with eslint
turbo format Checks formatting with prettier
turbo format:fix Fixes formatting errors with prettier
turbo typecheck Checks types with TypeScript
turbo sb Starts storybook at http://localhost:6006
turbo sb:build Build your production storybook to ./storybook-static/
turbo check Checks everything

You can also run all tasks with bun run, i.e bun run dev