https://github.com/vwh/revite

Quick starter template for your React project includes Vite, ShadcnUI, Tailwind, Lucide and more
https://github.com/vwh/revite

lucide-react prettier react react-starter react-starter-project shadcn-ui tailwindcss template template-project typescript vite vite-starter vite-starter-template vite-template vite-template-react

Last synced: about 21 hours ago
JSON representation

Quick starter template for your React project includes Vite, ShadcnUI, Tailwind, Lucide and more

• Host: GitHub
• URL: https://github.com/vwh/revite
• Owner: vwh
• License: mit
• Created: 2024-07-25T14:58:52.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T19:04:46.000Z (8 days ago)
• Last Synced: 2024-09-20T06:55:56.283Z (5 days ago)
• Topics: lucide-react, prettier, react, react-starter, react-starter-project, shadcn-ui, tailwindcss, template, template-project, typescript, vite, vite-starter, vite-starter-template, vite-template, vite-template-react
• Language: TypeScript
• Homepage:
• Size: 858 KB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
ReVite





  QuickStarter for React with Vite: A streamlined template to kickstart your React projects with essential features built-in. Boost your development process with speed and efficiency.





  

    

  

  

    

  








  

    

  



## 🗃️ Project Structure

```bash

ReVite/

├── components.json             # Configuration for Shadcn UI components

├── index.html                  # Main HTML file

├── package.json                # Project metadata and dependencies

├── prettier.config.js          # Prettier configuration

├── public/                     # Public assets

│   └── images/                 # Image assets

├── src/                        # Source files

│   ├── App.tsx                 # Main app component

│   ├── components/             # React components

│   │   └── ui/                 # UI components

│   ├── hooks/                  # Custom hooks

│   ├── index.css               # Main CSS file

│   ├── lib/                    # Utility functions

│   ├── main.tsx                # Main entry point

│   └── vite-env.d.ts           # TypeScript Vite environment definitions

├── tailwind.config.js          # Tailwind CSS configuration

├── tsconfig.app.json           # TypeScript app configuration

├── tsconfig.json               # TypeScript base configuration

├── tsconfig.node.json          # TypeScript Node configuration

└── vite.config.ts              # Vite configuration

```

## 🚀 Getting Started

### 📥 Installation

Clone the repository and install dependencies:

```bash

git clone https://github.com/vwh/revite

cd revite

# Using Bun

bun install

# Or using npm

npm install

```

### 💻 Development Server

Start the development server:

```bash

# Using Bun

bun run dev

# Or using npm

npm run dev

```

### 🏗️ Build

Build the project for production:

```bash

# Using Bun

bun run build

# Or using npm

npm run build

```

### 👀 Preview

Preview the production build locally:

```bash

# Using Bun

bun run preview

# Or using npm

npm run preview

```

### 🧹 Linting

Lint the project files:

```bash

# Using Bun

bun run lint

# Or using npm

npm run lint

```

### 🎨 Formatting

Format the project files:

```bash

# Using Bun

bun run format

# Or using npm

npm run format

```

Check the formatting:

```bash

# Using Bun

bun run format:check

# Or using npm

npm run format:check

```

## 🤝 Contributing

Contributions are welcome! Feel free to open a pull request with your improvements or fixes.