shakibhasan09/starter-kit

The Starter Kit accelerates web development with React, Tailwind CSS, and Vite. It ensures code quality with ESLint and testing with Vitest. Integrated with React Query, ApexCharts, and more, it's your go-to foundation for creating robust web applications.

Starter Kit

Description

This is a starter kit designed to jumpstart your project development. It comes pre-configured with essential tools and libraries to facilitate your workflow.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and pnpm installed on your machine.

Installation

To install the dependencies, follow these steps:

1. Clone the repository:

   git clone https://github.com/shakibhasan09/starter-kit.git

2. Navigate into the project directory:

   cd starter-kit

3. Install dependencies:

   pnpm install

Usage

To start the development server, run:

pnpm run dev

To build your project for production, run:

pnpm run build

To lint your code, run:

pnpm run lint

To preview your production build locally, run:

pnpm run preview

For testing, you have the following options:

Run all test

pnpm run test

Run UI tests:

pnpm run test:ui

Run tests in watch mode:

pnpm run test:watch

Generate test coverage report:

pnpm run test:coverage

Dependencies

This starter kit includes the following dependencies:

• React - A JavaScript library for building user interfaces.
• Tailwind CSS - A utility-first CSS framework for rapid UI development.
• Vite - A next-generation frontend build tool.
• TypeScript - A typed superset of JavaScript that compiles to plain JavaScript.
• ESLint - A pluggable and configurable linter tool for identifying and fixing problems in JavaScript code.
• PostCSS - A tool for transforming CSS with JavaScript plugins.
• And more...

For a full list of dependencies, check the package.json file.

License

This project is licensed under the MIT License - see the LICENSE file for details.