|
| 1 | +# 💰 Financial SaaS - Smart Financial Management Software | نرمافزار مدیریت مالی هوشمند |
| 2 | + |
| 3 | +<div align="center"> |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +</div> |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 📋 Table of Contents | فهرست مطالب |
| 16 | + |
| 17 | +- [English](#english) |
| 18 | +- [فارسی](#فارسی) |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +# English |
| 23 | + |
| 24 | +## 🌟 Introduction |
| 25 | + |
| 26 | +**Financial SaaS** is a professional and comprehensive financial management software built with modern technologies. This software can be used as a desktop application (with Electron) and web-based, providing complete features for managing finances of companies and businesses. |
| 27 | + |
| 28 | +## ✨ Features |
| 29 | + |
| 30 | +### 🎨 UI/UX |
| 31 | +- ✅ **Dark/Light theme** with instant switching |
| 32 | +- ✅ **Glassmorphism UI** inspired by macOS |
| 33 | +- ✅ **Full Persian & English support** (RTL/LTR) |
| 34 | +- ✅ **Smooth animations** with Framer Motion |
| 35 | +- ✅ **Floating windows** with minimize/maximize/close |
| 36 | +- ✅ **macOS-style Dock** at the bottom |
| 37 | + |
| 38 | +### 🔐 Authentication & Security |
| 39 | +- ✅ **Login/Register system** with username and password |
| 40 | +- ✅ **Default user:** `admin / admin` |
| 41 | +- ✅ **Role-based route protection** |
| 42 | +- ✅ **Session storage** in localStorage |
| 43 | + |
| 44 | +### 💼 Financial Management |
| 45 | +- ✅ **Professional dashboard** with interactive charts |
| 46 | +- ✅ **Product management** (add/edit/delete) |
| 47 | +- ✅ **Company & employee management** with salary tracking |
| 48 | +- ✅ **Invoice system** with PDF/Excel export |
| 49 | +- ✅ **Automatic tax & discount calculation** |
| 50 | +- ✅ **Financial reports** (profit/loss, balance sheet, etc.) |
| 51 | + |
| 52 | +### 📊 Analytics & Business Intelligence |
| 53 | +- ✅ **Advanced charts** with Recharts |
| 54 | +- ✅ **Profit/Loss analysis** (numerical & graphical) |
| 55 | +- ✅ **Smart suggestions** based on financial data |
| 56 | +- ✅ **Sales forecast** (monthly & quarterly) |
| 57 | + |
| 58 | +### 🖥️ Tech Stack |
| 59 | + |
| 60 | +#### Frontend (Electron + React) |
| 61 | +| Technology | Purpose | |
| 62 | +|-----------|---------| |
| 63 | +| React 18 | Core library | |
| 64 | +| TypeScript | Type safety | |
| 65 | +| Electron | Desktop app | |
| 66 | +| Vite | Builder & dev server | |
| 67 | +| TailwindCSS | Styling | |
| 68 | +| Framer Motion | Animations | |
| 69 | +| Recharts | Charts | |
| 70 | +| Lucide React | Icons | |
| 71 | +| jsPDF | PDF export | |
| 72 | + |
| 73 | +#### Backend (NestJS) |
| 74 | +| Technology | Purpose | |
| 75 | +|-----------|---------| |
| 76 | +| NestJS | Backend framework | |
| 77 | +| Prisma | ORM & database | |
| 78 | +| PostgreSQL | Main database | |
| 79 | +| Redis | Cache & session | |
| 80 | +| JWT | Authentication | |
| 81 | +| Passport | Auth strategies | |
| 82 | +| bcrypt | Password hashing | |
| 83 | + |
| 84 | +## 🚀 Installation & Setup |
| 85 | + |
| 86 | +### Prerequisites |
| 87 | +- Node.js 18+ |
| 88 | +- npm 8+ |
| 89 | +- Docker (optional) |
| 90 | +- PostgreSQL (via Docker or local) |
| 91 | + |
| 92 | +### Quick Start |
| 93 | + |
| 94 | +#### 1️⃣ Clone the repository |
| 95 | +```bash |
| 96 | +git clone https://github.com/your-repo/financial-saas.git |
| 97 | +cd financial-saas |
| 98 | +``` |
| 99 | + |
| 100 | +#### 2️⃣ Install dependencies |
| 101 | +```bash |
| 102 | +npm install |
| 103 | +``` |
| 104 | + |
| 105 | +#### 3️⃣ Setup database with Docker (optional) |
| 106 | +```bash |
| 107 | +docker run -d --name financial-postgres -e POSTGRES_DB=financial_saas -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=secure_password123 -p 5432:5432 postgres:15-alpine |
| 108 | +``` |
| 109 | + |
| 110 | +#### 4️⃣ Configure environment |
| 111 | +```bash |
| 112 | +cd packages/backend |
| 113 | +cp .env.example .env |
| 114 | +# Edit .env file with your database info |
| 115 | +``` |
| 116 | + |
| 117 | +#### 5️⃣ Run backend |
| 118 | +```bash |
| 119 | +cd packages/backend |
| 120 | +npm run dev |
| 121 | +# Backend runs on http://localhost:4000 |
| 122 | +``` |
| 123 | + |
| 124 | +#### 6️⃣ Run frontend |
| 125 | +```bash |
| 126 | +cd packages/frontend |
| 127 | +npm run dev |
| 128 | +# Frontend runs on http://localhost:3000 |
| 129 | +``` |
| 130 | + |
| 131 | +#### 7️⃣ Run Electron (Desktop app) |
| 132 | +```bash |
| 133 | +cd packages/frontend |
| 134 | +npm run electron |
| 135 | +``` |
| 136 | + |
| 137 | +#### 8️⃣ Run everything together |
| 138 | +```bash |
| 139 | +# From root folder |
| 140 | +npm run dev |
| 141 | +``` |
| 142 | + |
| 143 | +## 🔑 Default Users |
| 144 | + |
| 145 | +| Role | Username | Password | |
| 146 | +|------|----------|----------| |
| 147 | +| Admin | admin | admin | |
| 148 | +| Regular User | user | user | |
| 149 | + |
| 150 | +## 📁 Project Structure |
| 151 | + |
| 152 | +``` |
| 153 | +financial-saas/ |
| 154 | +├── packages/ |
| 155 | +│ ├── backend/ # NestJS backend |
| 156 | +│ │ ├── src/ |
| 157 | +│ │ │ ├── auth/ # Authentication |
| 158 | +│ │ │ ├── prisma/ # Database models |
| 159 | +│ │ │ ├── hr/ # Human resources |
| 160 | +│ │ │ ├── payment/ # Payment |
| 161 | +│ │ │ └── ai/ # AI analysis |
| 162 | +│ │ ├── prisma/ |
| 163 | +│ │ │ └── schema.prisma |
| 164 | +│ │ └── package.json |
| 165 | +│ │ |
| 166 | +│ └── frontend/ # React + Electron frontend |
| 167 | +│ ├── src/ |
| 168 | +│ │ ├── components/ |
| 169 | +│ │ │ ├── auth/ # Login components |
| 170 | +│ │ │ ├── Window.tsx # Main window |
| 171 | +│ │ │ ├── Dock.tsx # Bottom dock |
| 172 | +│ │ │ ├── Dashboard.tsx |
| 173 | +│ │ │ └── ... |
| 174 | +│ │ ├── contexts/ # Context API |
| 175 | +│ │ ├── utils/ # Helper functions |
| 176 | +│ │ └── types/ # TypeScript types |
| 177 | +│ ├── electron/ # Electron files |
| 178 | +│ │ └── main.cjs |
| 179 | +│ └── package.json |
| 180 | +│ |
| 181 | +├── docker-compose.yml # Docker config |
| 182 | +└── package.json # Root package |
| 183 | +``` |
| 184 | + |
| 185 | +--- |
| 186 | + |
| 187 | +# فارسی |
| 188 | + |
| 189 | +<div dir="rtl" align="right"> |
| 190 | + |
| 191 | +## 🌟 معرفی پروژه |
| 192 | + |
| 193 | +**Financial SaaS** یک نرمافزار مدیریت مالی حرفهای و کامل است که با استفاده از تکنولوژیهای مدرن ساخته شده. این نرمافزار به صورت دسکتاپ (با Electron) و تحت وب قابل استفاده است و امکانات کاملی برای مدیریت امور مالی شرکتها و کسبوکارها ارائه میدهد. |
| 194 | + |
| 195 | +## ✨ امکانات پروژه |
| 196 | + |
| 197 | +### 🎨 ظاهر و رابط کاربری |
| 198 | +- ✅ **تم دارک و روشن** با قابلیت تغییر لحظهای |
| 199 | +- ✅ **رابط کاربری شیشهای (Glassmorphism)** شبیه macOS |
| 200 | +- ✅ **پشتیبانی کامل از زبان فارسی و انگلیسی** (RTL/LTR) |
| 201 | +- ✅ **انیمیشنهای نرم و حرفهای** با Framer Motion |
| 202 | +- ✅ **پنجرههای شناور** با قابلیت بزرگ/کوچک کردن و بستن |
| 203 | +- ✅ **منوی داک (Dock)** شبیه macOS در پایین صفحه |
| 204 | + |
| 205 | +### 🔐 احراز هویت و امنیت |
| 206 | +- ✅ **سیستم ورود و ثبتنام** با یوزرنیم و پسورد |
| 207 | +- ✅ **کاربر پیشفرض:** `admin / admin` |
| 208 | +- ✅ **محافظت از مسیرها** بر اساس نقش کاربر |
| 209 | +- ✅ **ذخیره سشن** در localStorage |
| 210 | + |
| 211 | +### 💼 مدیریت مالی |
| 212 | +- ✅ **داشبورد حرفهای** با نمودارهای تعاملی |
| 213 | +- ✅ **مدیریت محصولات** با قابلیت افزودن/ویرایش/حذف |
| 214 | +- ✅ **مدیریت شرکتها و کارمندان** با ثبت حقوق |
| 215 | +- ✅ **سیستم فاکتور** با خروجی PDF و Excel |
| 216 | +- ✅ **محاسبه خودکار مالیات و تخفیف** |
| 217 | +- ✅ **گزارشات مالی** متنوع (سود و زیان، ترازنامه و ...) |
| 218 | + |
| 219 | +### 📊 تحلیل و هوش تجاری |
| 220 | +- ✅ **نمودارهای پیشرفته** با Recharts |
| 221 | +- ✅ **تحلیل سود و زیان** به صورت عددی و نموداری |
| 222 | +- ✅ **پیشنهادات هوشمند** بر اساس دادههای مالی |
| 223 | +- ✅ **پیشبینی فروش** ماهانه و فصلی |
| 224 | + |
| 225 | +### 🖥️ تکنولوژیهای استفاده شده |
| 226 | + |
| 227 | +#### فرانتاند (Electron + React) |
| 228 | +| تکنولوژی | کاربرد | |
| 229 | +|----------|--------| |
| 230 | +| React 18 | کتابخانه اصلی | |
| 231 | +| TypeScript | تایپسیفتی | |
| 232 | +| Electron | ساخت برنامه دسکتاپ | |
| 233 | +| Vite | بیلدر و سرور توسعه | |
| 234 | +| TailwindCSS | استایلدهی | |
| 235 | +| Framer Motion | انیمیشن | |
| 236 | +| Recharts | نمودارها | |
| 237 | +| Lucide React | آیکونها | |
| 238 | +| jsPDF | خروجی PDF | |
| 239 | + |
| 240 | +#### بکاند (NestJS) |
| 241 | +| تکنولوژی | کاربرد | |
| 242 | +|----------|--------| |
| 243 | +| NestJS | فریمورک بکاند | |
| 244 | +| Prisma | ORM و مدیریت دیتابیس | |
| 245 | +| PostgreSQL | دیتابیس اصلی | |
| 246 | +| Redis | کش و سشن | |
| 247 | +| JWT | احراز هویت | |
| 248 | +| Passport | استراتژیهای احراز هویت | |
| 249 | +| bcrypt | هش کردن رمز | |
| 250 | + |
| 251 | +## 🚀 راهاندازی پروژه |
| 252 | + |
| 253 | +### پیشنیازها |
| 254 | +- Node.js 18+ |
| 255 | +- npm 8+ |
| 256 | +- Docker (اختیاری) |
| 257 | +- PostgreSQL (با Docker یا نصب محلی) |
| 258 | + |
| 259 | +### نصب و اجرا |
| 260 | + |
| 261 | +#### 1️⃣ کلون کردن پروژه |
| 262 | +```bash |
| 263 | +git clone https://github.com/your-repo/financial-saas.git |
| 264 | +cd financial-saas |
| 265 | +``` |
| 266 | + |
| 267 | +#### 2️⃣ نصب وابستگیها |
| 268 | +```bash |
| 269 | +npm install |
| 270 | +``` |
| 271 | + |
| 272 | +#### 3️⃣ راهاندازی دیتابیس با Docker (اختیاری) |
| 273 | +```bash |
| 274 | +docker run -d --name financial-postgres -e POSTGRES_DB=financial_saas -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=secure_password123 -p 5432:5432 postgres:15-alpine |
| 275 | +``` |
| 276 | + |
| 277 | +#### 4️⃣ تنظیم محیط |
| 278 | +```bash |
| 279 | +cd packages/backend |
| 280 | +cp .env.example .env |
| 281 | +# ویرایش فایل .env با اطلاعات دیتابیس |
| 282 | +``` |
| 283 | + |
| 284 | +#### 5️⃣ اجرای بکاند |
| 285 | +```bash |
| 286 | +cd packages/backend |
| 287 | +npm run dev |
| 288 | +# بکاند روی http://localhost:4000 اجرا میشود |
| 289 | +``` |
| 290 | + |
| 291 | +#### 6️⃣ اجرای فرانتاند |
| 292 | +```bash |
| 293 | +cd packages/frontend |
| 294 | +npm run dev |
| 295 | +# فرانتاند روی http://localhost:3000 اجرا میشود |
| 296 | +``` |
| 297 | + |
| 298 | +#### 7️⃣ اجرای Electron (برنامه دسکتاپ) |
| 299 | +```bash |
| 300 | +cd packages/frontend |
| 301 | +npm run electron |
| 302 | +``` |
| 303 | + |
| 304 | +#### 8️⃣ اجرای همزمان همه با هم |
| 305 | +```bash |
| 306 | +# از پوشه اصلی |
| 307 | +npm run dev |
| 308 | +``` |
| 309 | + |
| 310 | +## 🔑 کاربران پیشفرض |
| 311 | + |
| 312 | +| نقش | یوزرنیم | رمز عبور | |
| 313 | +|------|---------|----------| |
| 314 | +| مدیر کل | admin | admin | |
| 315 | +| کاربر عادی | user | user | |
| 316 | + |
| 317 | +``` |
| 318 | +
|
| 319 | +## 🛠️ عیبیابی مشکلات رایج |
| 320 | +
|
| 321 | +### ۱. خطای `Cannot find module` |
| 322 | +```bash |
| 323 | +npm install |
| 324 | +``` |
| 325 | + |
| 326 | +### ۲. خطای اتصال به دیتابیس |
| 327 | +```bash |
| 328 | +# چک کنید دیتابیس روشن است |
| 329 | +docker ps |
| 330 | + |
| 331 | +# یا دیتابیس را ریستارت کنید |
| 332 | +docker restart financial-postgres |
| 333 | +``` |
| 334 | + |
| 335 | +### ۳. خطای `ERR_FILE_NOT_FOUND` در Electron |
| 336 | +```bash |
| 337 | +cd packages/frontend |
| 338 | +npm run build |
| 339 | +npm run electron |
| 340 | +``` |
| 341 | + |
| 342 | +## 📜 مجوز |
| 343 | + |
| 344 | +این پروژه تحت لیسانس MIT منتشر شده است. |
| 345 | + |
| 346 | +## 👥 توسعهدهندگان |
| 347 | + |
| 348 | +- تیم توسعه Financial SaaS |
| 349 | + |
| 350 | +--- |
| 351 | + |
| 352 | +**نرمافزار حسابداری و مدیریت مالی هوشمند - ساخته شده با ❤️ در ایران** |
| 353 | + |
| 354 | +</div> |
0 commit comments