142 lines
3.7 KiB
Markdown
142 lines
3.7 KiB
Markdown
# AgenticIQ
|
|
|
|
A modern React application built with TypeScript, Tailwind CSS, and shadcn/ui, following **AgenticIQ Enterprise Coding Guidelines & Best Practices Version 1.0** from Tech4Biz Solutions Pvt Ltd.
|
|
|
|
## 🚀 Features
|
|
|
|
- ⚡ **Vite** - Lightning-fast build tool
|
|
- ⚛️ **React 18** with TypeScript
|
|
- 🎨 **Tailwind CSS** - Utility-first CSS framework
|
|
- 🧩 **shadcn/ui** - Beautiful, accessible component library
|
|
- 📱 **Responsive Design** - Mobile-first with 7 breakpoints
|
|
- 🔒 **Type Safety** - Strict TypeScript configuration
|
|
- 📦 **Path Aliases** - Clean imports with `@/` prefix
|
|
- 🎯 **Best Practices** - Following enterprise coding standards
|
|
|
|
## 📋 Prerequisites
|
|
|
|
- Node.js 18+
|
|
- npm or yarn
|
|
|
|
## 🛠️ Installation
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone <repository-url>
|
|
cd AgenticIQ
|
|
```
|
|
|
|
2. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Create environment file:
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
4. Start development server:
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
## 📁 Project Structure
|
|
|
|
Following AgenticIQ guidelines, the project is organized as:
|
|
|
|
```
|
|
src/
|
|
├── components/ # Reusable UI components
|
|
│ └── ui/ # shadcn/ui components
|
|
├── pages/ # Route-level components
|
|
├── hooks/ # Custom React hooks
|
|
├── services/ # API calls and external services
|
|
├── utils/ # Helper functions
|
|
├── types/ # TypeScript type definitions
|
|
├── constants/ # Application constants
|
|
└── lib/ # Third-party library configurations
|
|
```
|
|
|
|
## 🎨 Responsive Breakpoints
|
|
|
|
Following AgenticIQ responsive design guidelines:
|
|
|
|
- **Mobile S** (`< 375px`): Extra small mobile devices
|
|
- **Mobile M** (`375px - 424px`): Standard mobile devices
|
|
- **Mobile L** (`425px - 767px`): Large mobile devices
|
|
- **Tablet** (`768px - 1023px`): Tablet devices
|
|
- **Laptop** (`1024px - 1439px`): Laptop screens
|
|
- **Desktop** (`1440px - 1919px`): Desktop screens
|
|
- **Large Display** (`≥ 1920px`): Large displays
|
|
|
|
## 📝 Naming Conventions
|
|
|
|
Following AgenticIQ standards:
|
|
|
|
- **Components/Interfaces**: `PascalCase`
|
|
- **Functions/Variables**: `camelCase`
|
|
- **Constants**: `SCREAMING_SNAKE_CASE`
|
|
- **CSS Classes/Files**: `kebab-case`
|
|
- **Private Fields**: `_camelCase`
|
|
|
|
## 🧪 Available Scripts
|
|
|
|
- `npm run dev` - Start development server
|
|
- `npm run build` - Build for production
|
|
- `npm run preview` - Preview production build
|
|
- `npm run lint` - Run ESLint
|
|
|
|
## 📚 Adding shadcn/ui Components
|
|
|
|
To add new shadcn/ui components:
|
|
|
|
```bash
|
|
npx shadcn@latest add button
|
|
npx shadcn@latest add card
|
|
npx shadcn@latest add input
|
|
```
|
|
|
|
## 🎯 Code Quality Standards
|
|
|
|
This project follows:
|
|
|
|
- **File Size**: < 250 lines per file
|
|
- **Function Parameters**: Max 4 parameters
|
|
- **Nesting Levels**: Max 3 levels
|
|
- **Test Coverage**: Min 80% line coverage
|
|
- **Documentation**: JSDoc for all public functions
|
|
|
|
## 🔒 Security
|
|
|
|
- Input validation on client and server
|
|
- XSS prevention
|
|
- CSRF protection
|
|
- Secure authentication practices
|
|
|
|
## 📖 Documentation
|
|
|
|
All functions include JSDoc comments with:
|
|
- `@description` - What the function does
|
|
- `@param` - Parameter descriptions
|
|
- `@returns` - Return value description
|
|
- `@throws` - Possible errors
|
|
- `@example` - Usage examples
|
|
|
|
## 🤝 Contributing
|
|
|
|
Follow the AgenticIQ Enterprise Coding Guidelines when contributing:
|
|
|
|
1. Use conventional commits (`feat:`, `fix:`, `docs:`, etc.)
|
|
2. Follow branching strategy (`feature/`, `bugfix/`, `hotfix/`)
|
|
3. Maintain code quality standards
|
|
4. Add tests for new features
|
|
|
|
## 📄 License
|
|
|
|
[Your License Here]
|
|
|
|
## 🙏 Acknowledgments
|
|
|
|
Built following **AgenticIQ Enterprise Coding Guidelines & Best Practices Version 1.0** by Tech4Biz Solutions Pvt Ltd.
|