Skip to content

aibiansari/vite-react-app-boilerplate

Repository files navigation

Vite React App Boilerplate

A minimalist Vite React app boilerplate with TypeScript, Tailwind CSS for styling, Shadcn components & React icons Setup. This template is designed to help you kickstart your project with a clean and modern starting point.

Features

  • Dark-themed design with a sleek and professional appearance.
  • Tailwind CSS for easy and flexible styling.
  • TypeScript for type checking and improved developer experience.
  • Shadcn components integrated for UI elements.
  • React Icons for scalable vector icons.
  • Simple layout with centered content and a footer.
  • Github Pages Deployment Setup

Getting Started

  1. Clone the repository:
    git clone https://github.com/aibiansari/vite-react-app-boilerplate.git
    
  2. Navigate to the project directory:
    cd vite-react-app-boilerplate
    
  3. Install Dependencies:
    npm install
    
  4. Run Development Server
    npm run dev
    
    

Github Pages Deployment Guide

1. Set base path in vite.config.ts

image

2. On your Repo Page:

  • Go to SettingsActionsGeneral,
  • Scroll down to Workflow Permissions,
  • Choose Read and Write, and Save:

3. Re-run actions

  • Actions → Choose a failed deployment → Re-run failed jobs. Wait until it finishes.

4. Configure GitHub Pages:

  • Go to SettingsPages
  • Under Source, choose "Deploy from branch" and select the "gh-pages" branch.
  • Click Save.

Once the workflow finishes successfully, you'll see a new deployment on your GitHub Pages. Click the link to access your deployed Vite React application!

Customization

Feel free to customize the text, styling, and layout according to your project's requirements. The provided template is a great starting point for building your application.

Authors

License

This project is open-source and available under the MIT License. Clone, use, and modify it freely!

About

A modern boilerplate for starting new projects with Vite, React, and Tailwind CSS.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published