Skip to content

Im-Fran/vite-react-ts-template

Repository files navigation

Vite + React + TypeScript Template

A fast and feature-rich template for building modern web applications using Vite, React, TypeScript, TailwindCSS, and React Router. This template provides a streamlined setup for rapid development and is designed to be fully extensible.

Features

  • Vite: Lightning-fast build tool for modern web projects.
  • 🔥 React: A powerful UI library for building user interfaces.
  • TypeScript: Static typing for better development with improved IDE support.
  • 🚀 SWC: Super-fast JavaScript/TypeScript compiler.
  • 🎨 TailwindCSS v4: Utility-first CSS framework for building custom designs.
  • 🌍 React Router: Declarative routing for React.
  • 📢 React Hot Toast: Lightweight toast notifications.
  • 💡 Class Variance Authority: Reusable component variants.
  • 🛠️ Bun.sh: All-in-one JavaScript runtime & toolkit.

Getting Started

To get started with this template, follow these steps:

  1. Use the Bun CLI to create a new project from this template
bun create Im-Fran/vite-react-ts-template <dir>
  1. Navigate to the project directory
cd <dir>
  1. Install dependencies
bun install
  1. Start the development server
bun run dev

This will start the Vite development server, and you can view your app at http://localhost:3000.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Contributing

We welcome contributions! If you’d like to contribute to this project, feel free to fork the repository and submit a pull request. Please ensure that your code follows the project’s conventions and passes the tests before submitting your changes.

Acknowledgments

•	Vite
•	React
•	TypeScript
•	TailwindCSS
•	Bun.sh

Explanation of the Sections:

  • Introduction: Describes the purpose of the repository and the technologies used.
  • Features: Lists the key technologies and features integrated into the template.
  • Getting Started: Provides the steps for setting up and running the project.
  • License: Mentions the project license under GNU GPLv3.
  • Contributing: A section for potential contributors to understand how they can contribute.
  • Acknowledgments: Acknowledges the tools and libraries used in the project.