README.md

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

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:

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

# Using Bun
bun install

# Or using npm
npm install

💻 Development Server

Start the development server:

# Using Bun
bun run dev

# Or using npm
npm run dev

🏗️ Build

Build the project for production:

# Using Bun
bun run build

# Or using npm
npm run build

👀 Preview

Preview the production build locally:

# Using Bun
bun run preview

# Or using npm
npm run preview

🧹 Linting

Lint the project files:

# Using Bun
bun run lint

# Or using npm
npm run lint

🎨 Formatting

Format the project files:

# Using Bun
bun run format

# Or using npm
npm run format

Check the formatting:

# 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.