π’ Introduction
Setting up a new web application from scratch can be overwhelming, especially when dealing with multiple libraries and configurations. This starter kit provides a streamlined and efficient setup using the latest stable versions of Vite, Shadcn, Tailwind CSS, React, TypeScript and React Router. With this setup, you can focus on building your application instead of spending time on configurations and boilerplate code.
β Features
- β‘ Vite β A blazing-fast development environment for modern web applications with instant Hot Module Replacement (HMR).
- π¨ Shadcn β Beautiful, customizable, and accessible UI components built on Radix UI.
- π¨ Tailwind CSS β A utility-first CSS framework for rapid UI development.
- βοΈ React + TypeScript β A type-safe and efficient way to build scalable applications.
- π React Router β Client-side routing to create dynamic, multi-page applications.
- π ESLint + Prettier β Pre-configured for clean and maintainable code.
- π Dark Mode Support β Integrated theme toggling between light and dark mode.
- π Absolute Imports β Simplified imports using @/components, @/pages, etc.
β³ When and Why Should You Use This Project?
- You want a modern and fast React setup with minimal configuration.
- You are tired of manually setting up Tailwind CSS, React Router, and UI components.
- You need a developer-friendly environment with best practices, including linting, formatting, and structured organization.
- You are starting a new project and need a solid foundation to build upon.
- You want a scalable and maintainable project structure.
π οΈ How to Use
π Getting Started
Make sure you have node installed. If not, I recommend installing via nvm(Node Version Manager)
Clone this repository and install dependencies:
https://github.com/IshaTHub/Starter-Kit.git
cd my-project
pnpm install # or npm install / yarn install
π₯ Running the Development Server
pnpm dev # or npm run dev / yarn dev
Open your browser and navigate to http://localhost:5173 to see the application running.
π¦ Building for Production
pnpm build # or npm run build / yarn build
β
Linting & Formatting
pnpm lint # or npm run lint / yarn lint
pnpm format # or npm run format / yarn format
π§ TypeScript Configuration
- This starter kit comes pre-configured with TypeScript. The tsconfig.json file includes:
- Strict Type Checking β Ensures better type safety.
- Path Aliases β Allows easy imports like @/components/Button instead of relative paths.
- ES Module Support β Ensures compatibility with modern JavaScript tooling.
π§ Ready to Build?
This starter kit provides a strong foundation for your project. Whether you're building a personal project, a startup MVP, or an enterprise-level application, this setup gives you a modern, efficient, and scalable starting point.
- π§ Potential Enhancements You Can Add:
- State Management β Integrate Zustand, Redux, or Jotai if needed.
- API Handling β Add Axios or React Query for handling API requests efficiently.
- Authentication β Use NextAuth.js or Firebase Auth if your application requires authentication.
- Testing Setup β Jest, React Testing Library, or Cypress for unit and end-to-end testing.
- CI/CD Pipeline β Automate builds and deployments with GitHub Actions or Vercel.
π Start Building!
Feel free to fork and customize this starter kit to suit your needs. Contributions and suggestions are always welcome!
π‘ β Star this repository on GitHub if you found it useful!
Top comments (2)
Much needed! Thanks :)