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.