0.0.17 • Published 1 year ago
@paras205/react-ts-starter v0.0.17
React Vite Starter Template
This is a starter template for a React project with Vite as the build tool.
Features
- React 18 with hooks
- TypeScript
- Vite 2 for fast builds and dev server
- Chakra UI for styling
- React Router v6 for routing
- React Query for data fetching
- Framer Motion for animations
- i18next for internationalization
- React Helmet Async for managing page title and meta tags
- React Hook Form for form management
- Yup for form validation
- lint-staged and husky for automatic linting and formatting on commit
- CommitLint and Conventional Changelog CLI for generating changelogs
Getting Started
Prerequisites
- Node.js v14 or higher *Yarn (recommended) or NPM
Installation
- npx @paras205/react-ts-starter projectName
- Navigate to the project root directory and run yarn or npm install to install dependencies.
- Run yarn dev or npm run dev to start the development server.
Building for Production
Run yarn build or npm run build to build the project for production. The output will be located in the dist folder.
Running Tests
Run yarn test or npm run test to run the test suite.
Linting and Formatting
- Run yarn lint or npm run lint to lint the project.
- Run yarn format or npm run format to format the project.
Committing Changes
Run yarn commit or npm run commit to commit changes using the Commitizen CLI. This ensures that commits follow the Conventional Commits specification.
Generating Changelogs
Run yarn changelog or npm run changelog to generate a changelog based on commit messages using Conventional Changelog CLI.