revite

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

MIT License

Stars
10
Committers
2

๐Ÿ—ƒ๏ธ 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.

Related Projects