Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.99 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.99 KB
Raw

P.RE.T.T.V - Prettier React Typescript Tailwind Vite Template

P.RE.T.T.V is a fork of nrabhiram's Vite React Typescript Tailwind Template.

It uses Prettier, React TypeScript, Tailwind CSS, and Vite and is a template to be used as a starting point for new projects. It also includes the Prettier plugin for Tailwind CSS class auto-sorting, sample folders, and path aliases for better/cleaner imports.

Note: to keep the sample folders from being ignored, I have added some empty .gitkeep files. You can delete them or add them to your .gitignore file, but keep in mind that empty folders are not synced to GitHub

Technologies

React TypeScript Tailwind Prettier Vite

Development

Setup

  1. Use git clone https://github.com/himan7991/prettv your_project_name to clone this repo to a new folder
  2. ‼️IMPORTANT‼️ Navigate to the new folder and delete the .git folder
    • For Linux terminal: use rm -rf .git
    • For Windows terminal: use rm -recursive -force .git
    • For Windows CMD: use del /s .git
  3. Change the name and description in the package.json
  4. If you intend to deploy this to GitHub pages, change the base value on vite.config.ts to your project repo name
  5. (Optional) Run git init to initialize a new repository
  6. Run yarn install to install all of the project's dependencies
  7. Run yarn upgrade to upgrade all packages to their newest versions
  8. Build the project for production with yarn build

License

The project is available as open source under the MIT License terms.