Kookaat Frontend Core Package

This React library contains the following modules that will be consumed in Kookaat front-end projects.

Utility Modules:

• Cache Manager
• Push Notification Manager
• In-App Notification Manager
• Helpers

API Modules:

• API Endpoints
• Types and Interfaces

Hooks

• React Custom Hooks

Assets

• Icons
• etc.

Components

• This package follows Atomic Design principles and contains the following components:

  • Atoms
  • Molecules
  • Organisms

• You need to add the following line to content field in your tailwind.config.js file load components' styles because their tailwind styles are not prebuilt:

content: [
  ...// other paths
  "path/to/node_modules/kookaat-front-core/components/**/*.{js,ts,jsx,tsx}",
];

Make sure to replace path/to/node_modules with the actual path to your node_modules directory.

• Also, add any custom theme styles that has been used in components to your tailwind.config.js file.

CSS files

• This package exports a typography.css file that contains the typography styles used in Kookaat projects.

Publishing Workflow

1. Check package.json Files
   Check if a new directory has been added. If so, add new directories to files in package.json

2. Commit Changes
   Commit changes with proper message

3. Publish Patches
   Run publish:patch/publish:minor/publish:majorscript for increasing version and publishing package to npm registry.

4. Push
   Finally, push commits and tags to remote repository

Push Notification Module

serviceWorker.ts in Push Notification Module uses /sw/icon.png and /sw/badge.png URLs for providing icon and badge to push event.