Skip to content

React app boilerplate, configured with vite and tailwind.

Notifications You must be signed in to change notification settings

laxmanpokhrel/xmanscript-react-app-boilerplate

Repository files navigation

Commitizen friendly

Getting Started with the Starter Kit

Preparing Your Environment

Before you start working with this kit, it's essential to clean up any unnecessary files and folders:

  1. Remove unused routes in appRoutes.ts.
  2. Delete unnecessary pages in the pages folder.
  3. Clean up the HomePageTemplate.tsx file as required.

Quick Start Guide

  1. Use Yarn for package installation. If you inadvertently use npm install, make sure to delete the yarn.lock file, and then proceed with the installation using npm.

  2. Create a .env file and duplicate it from .env.sample.

  3. Start the development server by running yarn dev.

  4. If you encounter an error on the "/dashboard" route, consider commenting out the proxy setup part in the vite.config.ts file.

Husky Disabled Warning

If you encounter a Husky disabled warning on your device, please run the following two commands in your terminal:

chmod ug+x .husky/*
chmod ug+x .git/hooks/*