https://github.com/tanishraj/starter-vite-react-chakra-ts

Accelerate your development process with this ready-to-go Vite, React, Chakra UI, and TypeScript template.
https://github.com/tanishraj/starter-vite-react-chakra-ts

Last synced: 23 days ago
JSON representation

Accelerate your development process with this ready-to-go Vite, React, Chakra UI, and TypeScript template.

• Host: GitHub
• URL: https://github.com/tanishraj/starter-vite-react-chakra-ts
• Owner: tanishraj
• License: mit
• Created: 2023-07-29T17:08:55.000Z (over 1 year ago)
• Default Branch: develop
• Last Pushed: 2023-10-27T19:58:15.000Z (over 1 year ago)
• Last Synced: 2025-01-12T07:15:23.953Z (23 days ago)
• Language: TypeScript
• Size: 237 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vite-React-Chakra-TypeScript Starter

Start your React projects with this efficient template, combining the performance of Vite, the expressiveness of TypeScript, and the powerful UI components of Chakra.

## 🌟 Features:

- **Vite**: Enjoy faster and leaner development with Vite's no-bundler dev environment.

- **React 18**: Harness the power of the latest React version.

- **Chakra UI**: Build responsive and accessible user interfaces with ease.

- **TypeScript**: Add strong types to your React components for better code quality and developer experience.

- **Linting & Formatting**: Integrated ESLint, Prettier, and lint-staged ensure consistent code quality.

- **Husky & CommitLint**: Enforce commit message standards and automate hooks.

## 🚀 Quick Start:

### Prerequisites

- Node.js v16 or higher.

- PNPM v8 or higher. (Preferred package manager for this project)

### Setup & Installation:

1. Clone the repository:

   `git clone https://github.com/your_username/vite-react-chakra-typescript.git`

2. Change directory:

   `cd vite-react-chakra-typescript`

3. Install dependencies using `pnpm`: `pnpm install`

### Running the Application:

Start the development server:

`pnpm dev`

Your application will be available at `http://localhost:5173`.

## 🛠 Scripts:

- **Development**: `pnpm dev`

- **Production Build**: `pnpm build`

- **Preview Production Build**: `pnpm serve`

- **Linting**: `pnpm lint`

- **Auto-Fix Lint Issues**: `pnpm lint:fix`

- **Type Checking**: `pnpm typecheck`

- **Code Formatting**: `pnpm format`

- **Update Dependencies (Interactive)**: `pnpm up-interactive`

- **Release Versioning**: `pnpm release`

- **Push Release**: `pnpm push-release`

## 📦 Dependencies:

This template uses the following main libraries:

- **UI Components**: [@chakra-ui/react](https://chakra-ui.com/)

- **State Management**: [React Context API](https://reactjs.org/docs/context.html) (feel free to integrate Redux, Zustand, MobX, or others as per your needs)

- **Routing**: [react-router-dom](https://reactrouter.com/)

## 🤝 Contributing:

We welcome contributions! Please read the [contributing guidelines](CONTRIBUTING.md) to get started.

## 📜 License:

This project is licensed under the [MIT License](LICENSE).

## 📣 Feedback:

If you found this template useful or have suggestions, please give a ⭐ or fork and send a pull request. Your feedback is highly appreciated!