UNPKG

react-atomic-structure

Version:

A command-line tool to set up a predefined folder structure in a React project using Vite.

24 lines (18 loc) 1.36 kB
# Project Setup Package This package automates the process of setting up a modern web development project with essential tools and folder structure. It supports both **JavaScript** and **TypeScript** projects, and works seamlessly with **Yarn** or **npm**. ### Key Features: - **Automatic Folder Structure Creation**: Generates a comprehensive folder structure tailored for scalable React projects using atomic design principles. - **Dependency Management**: Installs essential dev dependencies such as `eslint`, `prettier`, `husky`, `postcss`, `typescript`, and `ts-node` with a single command. - **Configuration Setup**: - **ESLint**: Automatically sets up ESLint for React with recommended configurations and compatibility with React 19. - **Husky**: Configures Git hooks for pre-commit and pre-push to ensure consistent code quality. - **Prettier**: Generates configuration for consistent code formatting across your project. - **PostCSS & Autoprefixer**: Automatically sets up PostCSS with Autoprefixer for CSS compatibility. - **TypeScript Support**: Fully supports TypeScript projects and ensures smooth integration with Yarn or npm. ### Requirements: - Node.js (v14 or higher) - Yarn or npm ### Installation: 1. **Install the package globally** using npm or Yarn: ```bash npm install -g project-setup-package