0.0.24 β€’ Published 5 months ago

react-raika v0.0.24

Weekly downloads
-
License
ISC
Repository
-
Last release
5 months ago

πŸš€ React Starter for Raika

banner

A powerful and well-structured React boilerplate for our company, designed to streamline development and enforce best practices.


πŸ“¦ Getting Started

To create a new project using this boilerplate, run:

npx react-raika project-name

Then, start coding! πŸš€


πŸ”§ Features & Setup

βœ… Pre-Commit Linting & Formatting

When committing files, husky will automatically:
βœ”οΈ Run lint-staged
βœ”οΈ Lint & format changes
βœ”οΈ Build the project
βœ”οΈ Allow pushing only if everything passes

πŸ“Š Analyze Unused Files & Packages

Run:

npm run analyze

This helps identify unused files and dependencies.

πŸ§ͺ Testing Setup

  • Cypress β†’ Preconfigured for E2E testing πŸ› οΈ
  • Vitest β†’ Ready for unit testing ⚑

πŸš€ Upgrade Dependencies

Easily upgrade your dependencies with:

npx taze

πŸ“± PWA Support

  • Modify the manifest and Service Worker in public folder
  • Update icons in public/icons/

🎨 Custom Styling & Fonts

  • Replace fonts in src/assets/fonts/
  • Update _font.scss in src/styles/base/_font.scss

πŸ–ΌοΈ Icon Handling

  1. Add your SVGs to src/assets/icons/
  2. Import them in Icon.tsx
  3. Use them with <CustomIcon icon="your-icon" />

🌍 i18n & RTL Support

  • Multi-language support included
  • Configure RTL/LTR based on your project’s needs

πŸ”– Versioning & Releases

Run:

npm run release

Select the version type, and let the script handle the rest!


πŸ“š Preinstalled Libraries

This boilerplate includes essential tools and configurations to boost productivity.


🎯 Ready to start? Run the command, set up your project, and build amazing things! πŸš€