Skip to content

ReactInit is a boilerplate project designed to kickstart any React application with a robust and scalable structure. It includes a set of essential tools and libraries to streamline your development process.

License

Notifications You must be signed in to change notification settings

md-samsuzzoha/ReactInit

Repository files navigation

ReactInit

ReactInit is a boilerplate project designed to kickstart any React application with a robust and scalable structure. It includes a set of essential tools and libraries to streamline your development process.

Features

  • React: A JavaScript library for building user interfaces.
  • React Router DOM: Declarative routing for React applications.
  • Jest: Delightful JavaScript testing.
  • Vite: Next Generation Frontend Tooling.
  • Vitest: A Vite-native unit testing framework.
  • React Redux: A predictable state container for JavaScript apps.
  • TailwindCSS: A utility-first CSS framework.
  • TypeScript: Typed JavaScript at Any Scale.
  • Husky: Git hooks made easy.
  • Prettier: An opinionated code formatter.
  • React Hook Form: Performant, flexible, and extensible forms with easy-to-use validation.
  • Yup: JavaScript schema builder for value parsing and validation.
  • Redux Persist: Persist and rehydrate a Redux store.
  • Lodash: A modern JavaScript utility library delivering modularity, performance, and extras.
  • @hookform/resolvers: A collection of resolvers for React Hook Form validation.
  • @reduxjs/toolkit: The official, recommended way to write Redux logic.

Getting Started

Prerequisites

  • Node.js (>=14.x)
  • npm (>=6.x) or yarn (>=1.x)

Installation

  1. Clone the repository

    git clone https://github.com/your-username/ReactInit.git
    cd ReactInit
  2. Install dependencies

    npm install
    # or
    yarn install

Running the Project

To start the development server:

npm run dev
# or
yarn dev

Building the Project

To create a production build:

npm run build
# or
yarn build

Testing

To run the tests:

npm test
# or
yarn test

Folder Structure

ReactInit/
├── public/
├── src/
│   ├── assets/
│   ├── components/
│   ├── hooks/
│   ├── pages/
│   ├── store/
│   ├── utils/
│   ├── App.tsx
│   ├── main.tsx
│   ├── index.css
├── .husky/
├── .vscode/
├── .eslintrc.js
├── .prettierrc
├── index.html
├── package.json
├── tailwind.config.js
├── tsconfig.json
└── vite.config.ts

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bug fixes or enhancements.

License

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


Feel free to customize this README further to better suit your project.

About

ReactInit is a boilerplate project designed to kickstart any React application with a robust and scalable structure. It includes a set of essential tools and libraries to streamline your development process.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •