Awesome

React Boilerplate Template

A powerful and flexible boilerplate for starting React projects, leveraging Vite for fast builds, TypeScript for type safety, and built-in support for internationalization, SVG handling, and code quality tools like ESLint, Husky, and Prettier.

Table of Contents

• React Boilerplate Template
  • Table of Contents
  • Features
  • Version used for Major Dependencies
  • Project Folder Structure
  • Naming Conventions
  • Getting Started
    • 1. Clone the Repository
    • 2. Install direnv for the default environment
      • Setup the terminal for the default environment using the official website.
      • You can setup your desired node version in .nvmrc file.
      • Go into your project
    • 3. Install dependencies
    • 4. Git Hooks with Husky
    • 5. Change the prefix of branch name and commit message
    • 6. Configure Internationalization
    • 7. Configure SVGR for your project
    • 8. Update the README.template.md file
  • Contributing
  • License

Features

• Husky: Pre-commit hooks to enforce linting and testing rules before pushing code.
• ESLint: Configured with plugins for React, JSX accessibility, and Prettier integration.
• Prettier: Consistent code formatting across the project.
• Path Aliases: Simplified imports with custom path aliases.
• PR Template: Standardized pull request template to maintain code review consistency.
• direnv: Environment management for project-specific settings.
• EditorConfig: Editor configuration to maintain consistent coding styles across IDEs.
• Folder Structure: Organized project structure for scalable and maintainable code.
• Internationalization (i18n): Integrated i18next and react-i18next for handling multiple languages, enabling easy localization of content. The setup includes automatic language detection via the i18next-browser-languagedetector package, making the user experience seamless and adaptive based on browser settings.
• SVGR Integration: SVGs are handled using @svgr/cli, which converts SVG files into React components. This enables easy embedding and manipulation of SVG icons and graphics directly within the React codebase, keeping assets clean and code efficient.
• VSCode Configuration: The .vscode folder includes custom workspace settings, extensions, and code snippets to streamline development.
  • Extensions: Recommended VSCode extensions to ensure a consistent development environment across the team.
  • Settings: Predefined settings for formatting, linting, and other preferences to ensure uniformity in coding style.
  • Code Snippets: Custom snippets for commonly used code patterns, reducing boilerplate code and improving productivity.

Version used for Major Dependencies

This template serves as a solid foundation to kickstart new React projects, ensuring consistency, efficiency, and adherence to best practices across the team.

Project Folder Structure

.
├── .github                      # GitHub-specific workflows and templates
├── .husky                       # Husky pre-commit hooks (e.g., linting, testing)
├── .vscode                      # VSCode workspace settings and recommended extensions
├── src                          # Source files for the project
│   ├── assets                   # Static resources (images, fonts, etc.)
│   ├── components               # Reusable React components
│   ├── constants                # Application-wide constants
│   ├── https                    # HTTPS utility functions (API calls, etc.)
│   ├── pages                    # Page-level components
│   ├── routes                   # Application routes
│   ├── svgr                     # SVG to React components configuration
│   │   ├── index-template.cjs   # Template for exporting SVG components
│   │   ├── svgr-config.json     # SVGR configuration file
│   │   └── svgr-template.cjs    # Template for converting individual SVGs into React components
│   ├── theme                    # Theming files for typography, colors, spacing, etc.
│   └── types                    # TypeScript types
├── .editorconfig                # EditorConfig for consistent coding styles across IDEs
├── .envrc                       # Environment configuration using direnv
├── .gitignore                   # Git ignore file
├── .nvmrc                       # Node.js version configuration
├── .prettierignore              # Ignore file for Prettier
├── .prettierrc                  # Prettier configuration
├── .validate-branch-namerc.json # Configuration for validating branch names
├── commitlint.config.cjs        # Commit message linting configuration
├── eslint.config.js             # ESLint configuration
├── index.html                   # Main HTML file for the project
├── package.json                 # Project dependencies and scripts
├── package-lock.json            # Lockfile for package dependencies
├── README.md                    # Project readme
├── tsconfig.app.json            # TypeScript configuration for application code
├── tsconfig.json                # General TypeScript configuration
├── tsconfig.node.json           # TypeScript configuration for Node.js
└── vite.config.ts               # Vite configuration file

Naming Conventions

• Files/Folders
  • Component File: PascalCase.tsx
  • All other files/folders: kebab-case
• Variables
  • Global constants: SCREAMING_SNAKE_CASE
  • Component: PascalCase
  • Boolean variable or props: camelCase with prefix does, has, is and should
    • e.g. isLoading, doesContain, hasElement
  • Others: camelCase
• Types
  • Interfaces: PascalCase with I as prefix
    • e.g. IUser, IResponse
  • Enumerations: PascalCase
  • Types: PascalCase
• Methods/Functions
  • Methods/Functions: camelCase
  • Hooks: camelCase with use as prefix
    • e.g. useList, useDetails
  • Higher Order Components: camelCase with with as prefix
    • e.g. withTimer

Getting Started

Follow these steps to clone, set up, and start working with the project:

1. Clone the Repository

Use degit to clone the boilerplate template:

npx degit Aubergine-FE/react-basic-template <your-project-name>

2. Install direnv for the default environment

For macOS (Homebrew):

brew install direnv

For Ubuntu:

sudo apt install direnv

Setup the terminal for the default environment using the official website.

You can setup your desired node version in .nvmrc file.

Go into your project

cd your-project-name

# give permissions to direnv
direnv allow

3. Install dependencies

npm install

4. Git Hooks with Husky

Initialize the git repository

git init

Install the husky to setup the hooks.

npx husky@8.0.0 install

# now, you have running hooks setup in place.

Hooks can be disabled with:

npm run disable-hooks

Changed your mind? Enable hooks with:

npm run enable-hooks

5. Change the prefix of branch name and commit message

• You can configure the branch and commit message prefix in .validate-branch-namerc.json and commitlint.config.cjs files respectively.

6. Configure Internationalization

• You can go through i18n.ts and configure the localization settings accordingly. Also see the translations in assets/locales folder.

7. Configure SVGR for your project

• Change the color #1C202A in svgr-config.json to your default icon color. This will replace that color with the appropriate props.
• To generate the icon components
  • Put your icons in assets/icons
  • Now, Run npm run icons:create

8. Update the README.template.md file

• Change the file name from the README.template.md to README.md.
• Update the Project Name.
• Update the URLs for cloning the project.
• Add any more steps you have for onboarding in Getting Started

Contributing

• see CONTRIBUTING.md

License

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