Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 1.99 KB

README.md

File metadata and controls

104 lines (73 loc) · 1.99 KB
Raw

My Starter Vite React TypeScript Tailwind CSS

Starter

This project is a boilerplate for a modern web application using Vite.js, React, TypeScript, and Tailwind CSS.

It is set up with pnpm for package management.

Getting Started

Follow these instructions to set up and run the project locally.

Prerequisites

Make sure you have pnpm installed globally. If not, you can install it using npm:

npm install -g pnpm

or if you use yarn:

yarn global add pnpm

or if you use macos (highly recommended):

brew install pnpm

Clone the repository:

git clone https://github.com/gllmt/starter-vite-react-ts-tailwind.git

Navigate to the project directory:

cd starter-vite-react-ts-tailwind

Install the dependencies:

pnpm install

Start the development server:

pnpm dev

Build the project for production:

pnpm build

Project Structure

starter-vite-react-ts-tailwind/
├── public/
│   └── vite.svg
├── src/
│   ├── assets/
│   ├── components/
│   ├── App.tsx
│   ├── index.css
│   ├── main.tsx
│   └── vite-env.d.ts
├── index.html
├── package.json
├── pnpm-lock.yaml
├── postcss.config.js
├── tailwind.config.js
├── tsconfig.json
└── vite.config.ts

Customization

You can customize the project by editing the following files:

  • tailwind.config.js: Tailwind CSS configuration.
  • postcss.config.js: PostCSS configuration.
  • tsconfig.json: TypeScript configuration.
  • vite.config.ts: Vite configuration.

License

This project is licensed under the MIT License.

Acknowledgements