https://github.com/albindavidc/farmx-angular
https://github.com/albindavidc/farmx-angular
angular angular-material tailwindcss
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/albindavidc/farmx-angular
- Owner: albindavidc
- Created: 2025-03-24T03:42:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-30T03:44:39.000Z (9 months ago)
- Last Synced: 2025-09-30T05:37:47.178Z (9 months ago)
- Topics: angular, angular-material, tailwindcss
- Language: TypeScript
- Homepage:
- Size: 4.79 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌾 **FarmX - Clean Architecture Folder Structure**
FarmX is a modern application designed using **Clean Architecture** principles, ensuring **scalability, maintainability, and separation of concerns**. The project is divided into:
- 📌 **Frontend:** Built with **Angular**, using **NgRx** for state management.
- 📌 **Backend:** Powered by **Node.js + Express.js**, following a structured Clean Architecture approach.
---
## 📂 **Project Folder Structure**
### 🖥️ **Frontend (Angular)**
The frontend follows **Angular best practices**, emphasizing modularity, reusable components, and state management with **NgRx**.
### 📂 **Frontend Folder Structure**
```
farmx-frontend/
├── src/
│ ├── app/
│ │ ├── core/ # Core module
│ │ │ ├── auth/ # Authentication services and guards
│ │ │ │ ├── auth.service.ts # Auth service
│ │ │ │ ├── auth.guard.ts # Auth guard
│ │ │ │ ├── auth.interceptor.ts # Auth interceptor
│ │ │ │ ├── otp.service.ts # OTP service
│ │ │ │ └── google.auth.service.ts # Google Auth service
│ │ │ ├── services/ # Core services
│ │ │ │ ├── api.service.ts # API service
│ │ │ │ ├── notification.service.ts # Notification service
│ │ │ │ └── role.service.ts # Role service
│ │ │ └── models/ # Core models
│ │ │ ├── user.model.ts # User model
│ │ │ ├── role.model.ts # Role model
│ │ │ └── otp.model.ts # OTP model
│ │ │
│ │ ├── modules/ # Feature modules
│ │ │ ├── auth/ # Authentication module
│ │ │ │ ├── login/ # Login component
│ │ │ │ ├── register/ # Register component
│ │ │ │ ├── forgot-password/ # Forgot password component
│ │ │ │ └── otp-verification/ # OTP verification component
│ │ │ ├── user/ # User management module
│ │ │ │ ├── profile/ # Profile management component
│ │ │ │ ├── settings/ # Settings management component
│ │ │ │ └── role-management/ # Role management component
│ │ │ ├── article/ # Article management module
│ │ │ ├── event/ # Event management module
│ │ │ ├── course/ # Course management module
│ │ │ ├── certificate/ # Certificate management module
│ │ │ ├── chat/ # Chat management module
│ │ │ ├── community/ # Community management module
│ │ │ └── admin/ # Admin management module
│ │ │
│ │ ├── shared/ # Shared components and utilities
│ │ │ ├── components/ # Reusable components
│ │ │ ├── directives/ # Custom directives
│ │ │ ├── pipes/ # Custom pipes
│ │ │ └── models/ # Shared models
│ │ │
│ │ ├── state/ # NgRx state management
│ │ │ ├── auth/ # Auth state
│ │ │ ├── user/ # User state
│ │ │ ├── article/ # Article state
│ │ │ ├── event/ # Event state
│ │ │ ├── course/ # Course state
│ │ │ ├── certificate/ # Certificate state
│ │ │ ├── chat/ # Chat state
│ │ │ ├── community/ # Community state
│ │ │ └── admin/ # Admin state
│ │ │
│ │ ├── assets/ # Static assets
│ │ ├── styles/ # Global styles
│ │ │ ├── tailwind.css # Tailwind CSS
│ │ │ └── global.scss # Global SASS styles
│ │ │
│ │ ├── app.component.ts # Root component
│ │ ├── app.module.ts # Root module
│ │ ├── app-routing.module.ts # Root routing
│ │ └── app.config.ts # App-wide configuration
│ │
│ ├── environments/ # Environment configurations
│ │ ├── environment.ts # Development environment
│ │ └── environment.prod.ts # Production environment
│ │
│ ├── index.html # Main HTML file
│ ├── main.ts # Entry point
│ └── styles.scss # Global styles
│
├── .eslintrc.js # ESLint configuration
├── .prettierrc # Prettier configuration
├── angular.json # Angular CLI configuration
├── package.json # Frontend dependencies
├── tailwind.config.js # Tailwind CSS configuration
└── README.md # Project documentation
```
## 🚀 **Key Features Implementation**
### 🔒 **Backend Features**
✅ **Authentication & Authorization**
- JWT for secure **token-based authentication**.
- OAuth2 for **Google login integration**.
- **Role-Based Access Control (RBAC)** for managing user permissions.
✅ **Real-Time Services**
- **WebSockets** for live chat and notifications.
✅ **Performance Optimization**
- **Redis caching** for high-frequency data.
- **Elasticsearch** for advanced search & filtering.
✅ **Integrations**
- **Payment Gateway** for secure transactions.
- **Calendar API** for event scheduling.
---
### 🎨 **Frontend Features**
✅ **State Management**
- **NgRx** for centralized, predictable state management.
✅ **Styling & UI**
- **Tailwind CSS** + **SASS** for flexible, utility-first styling.
- **Reusable component library** for consistency across UI.
- **Dynamic UI rendering** based on **user roles**.
✅ **Offline & PWA**
- **Angular PWA** for **offline functionality** and better performance.