Skip to content

Latest commit

Β 

History

History
88 lines (57 loc) Β· 3.58 KB

File metadata and controls

88 lines (57 loc) Β· 3.58 KB

HxReact - Hippy's Hardcore React Setup Script πŸš€

An automated, interactive script for setting up a customized React application with your preferred frameworks, libraries, and toolsβ€”all tailored to your experience level. Boost your productivity and jumpstart your React projects with ease!

License Twitter Follow


🌟 Features

  • Interactive CLI: Guides you through setting up a React project with options suitable for both beginners and advanced users.
  • Customizable Configuration: Choose from popular frameworks like Next.js, Remix, Gatsby, Vite, or Create React App.
  • TypeScript Support: Optionally include TypeScript for enhanced code quality and error checking.
  • UI Libraries: Integrate UI frameworks like Tailwind CSS, Chakra UI, Material-UI, Ant Design, or styled-components.
  • State Management: Select from Redux Toolkit, Zustand, Jotai, Recoil, MobX, XState, or none.
  • Database/ORM Integration: Set up Prisma, Firebase, Mongoose, or SQLite as per your project needs.
  • GraphQL and Authentication: Optionally configure GraphQL clients (Apollo, Relay, urql) and authentication providers (Auth0, Firebase Auth, NextAuth.js).
  • Testing Frameworks: Include Jest, Vitest, or Cypress for robust testing.
  • Additional Tools: Automatically installs helpful packages like Axios, React Hook Form, Zod, React Query, Date-fns, React Icons, and Lodash.
  • Development Enhancements: Sets up ESLint, Prettier, Husky, and lint-staged for code quality and consistency.
  • Optional Add-ons: Supports Storybook, internationalization (i18n) with react-i18next, PWA capabilities, and CI/CD with GitHub Actions.

πŸš€ Why Use HxReact?

  • Save Time: Automate the tedious setup process and get straight to coding.
  • Beginner-Friendly: Provides detailed explanations and guides for newcomers.
  • Flexibility: Tailor your React project to your specific needs and preferences.
  • Consistency: Ensures best practices are followed with proper tooling and configurations.

πŸ“₯ Installation

# Clone the repository
git clone https://github.com/HxHippy/hxreact.git

# Navigate into the directory
cd hxreact-setup

# Make the script executable
chmod +x hxreact.sh

πŸ› οΈ Usage

# Run the script
./hxreact.sh

Follow the interactive prompts to set up your React application.


πŸ“š Documentation

For detailed information on the options and configurations, refer to the README.


πŸ“„ License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Attribution Notice: Users of this software must preserve the NOTICE file, which includes attribution to the original author and associated entities.


🀝 Connect with Us


Boost your React development workflow today with HxReact!


Feel free to open an issue or submit a pull request if you have any questions or suggestions.