autosync_backend2 1.2.29 → 1.2.31

package/README.md

@@ -1,25 +1,176 @@
-# Elysia with Bun runtime
+# Autosync v2
 
-## Getting Started
+A comprehensive business management system built with **Elysia** (TypeScript web framework) and **Bun** runtime. The system provides CRM, inventory management, warehouse operations, fleet management, and company management capabilities.
 
-To get started with this template, simply paste this command into your terminal:
+## 🚀 Quick Start
+
+### Prerequisites
+
+- [Bun](https://bun.sh) runtime (latest version)
+- PostgreSQL database
+- Redis (for caching and sessions)
+- AWS S3 account (for file storage)
+- SMTP credentials (for email)
+
+### Installation
+
+1. **Clone the repository**
+   ```bash
+   git clone <repository-url>
+   cd autosync-v2
+   ```
+
+2. **Install dependencies**
+   ```bash
+   bun install
+   ```
+
+3. **Set up environment variables**
+   
+   Create a `.env` file with the following variables:
+   ```env
+   NODE_ENV=development
+   PORT=3000
+   BETTER_AUTH_SECRET=your-secret-key
+   DATABASE_URL=postgresql://user:password@localhost:5432/autosync
+   UPSTASH_REDIS_REST_URL=your-redis-url
+   UPSTASH_REDIS_REST_TOKEN=your-redis-token
+   SMTP_USER=your-smtp-user
+   SMTP_PASSWORD=your-smtp-password
+   ATUT_TOKEN=your-atut-token
+   AWS_ACCESS_KEY=your-aws-key
+   AWS_SECRET_KEY=your-aws-secret
+   ```
+
+4. **Run database migrations**
+   ```bash
+   bun run db:migrate
+   ```
+
+5. **Start the development server**
+   ```bash
+   bun run dev
+   ```
+
+6. **Access the application**
+   - API: <http://localhost:3000/api>
+   - Health Check: <http://localhost:3000/health>
+   - Swagger Documentation: <http://localhost:3000/swagger>
+
+## 📚 Documentation
+
+- **[API Documentation](./docs/API.md)** - Complete API reference
+- **[Project Structure](./docs/STRUCTURE.md)** - Architecture and code organization
+- **[Project Index](./PROJECT_INDEX.md)** - High-level overview
+- **[Claude Guide](./CLAUDE.md)** - Development guidelines for AI assistants
+
+## 🛠️ Development
+
+### Available Commands
 
 ```bash
-bun create elysia ./elysia-example
+# Development
+bun run dev              # Start development server with auto-reload
+bun run build            # Compile TypeScript and generate declarations
+
+# Database
+bun run db:generate      # Generate migration files from schema changes
+bun run db:migrate       # Apply database migrations
+
+# Code Quality
+bun run biome:check      # Format and lint with auto-fix
+
+# Email Development
+bun run email            # Start email template development server
+
+# Testing
+bun test                 # Run test suite
+bun test:watch           # Run tests in watch mode
 ```
 
-## Development
+### Code Standards
+
+- **Indentation**: Tabs
+- **Quotes**: Double quotes
+- **Validation**: TypeBox (not Zod)
+- **Database Naming**: Snake_case
+- **TypeScript Naming**: camelCase
 
-To start the development server run:
+## 🏗️ Architecture
+
+The application follows a **domain-driven architecture** with the following main domains:
+
+- **Company Management** - Multi-tenant company management with branches, employees, and service packages
+- **CRM** - Customer relationship management with orders, payments, and service packages
+- **Fleet Management** - Fleet and machine management with preventive maintenance and inspections
+- **Warehouse Management** - Inventory and warehouse operations
+- **Technical Documentation** - Technical documentation for suppliers and vehicle specifications
+- **User & Permissions** - User authentication and role-based access control
+
+Each domain follows a consistent pattern:
+- `index.ts` - Route definitions and middleware
+- `model.ts` - TypeBox validation schemas
+- `logic.ts` - Business logic and database operations
+
+## 🗄️ Database
+
+The system uses **PostgreSQL** with **Drizzle ORM** and a multi-schema design:
+
+- `public` - Core application tables (auth, permissions)
+- `crm` - Customer relationship management
+- `company` - Organization management
+- `warehouse` - Inventory and warehouse operations
+- `techdoc` - Technical documentation
+- `fleet` - Fleet management
+
+## 🔐 Authentication & Authorization
+
+- **Authentication**: Better-auth library
+- **Authorization**: Granular permission system with Redis caching
+- **User Kinds**: ADMIN, COMPANY_ADMIN, CUSTOMER, EMPLOYEE
+
+## 📦 Key Technologies
+
+- **Runtime**: Bun
+- **Framework**: Elysia
+- **Database**: PostgreSQL with Drizzle ORM
+- **Authentication**: Better-auth
+- **Validation**: TypeBox
+- **Email**: React Email
+- **Storage**: AWS S3
+- **Caching**: Redis (Upstash)
+- **Code Quality**: Biome
+
+## 🐳 Docker
+
+### Build and Deploy
 
 ```bash
-bun run dev
+# Build and push to ECR
+make build
+
+# Build production image
+make build_prod
 ```
 
-Open <http://localhost:3000/> with your browser to see the result.
+## 📝 Баазийн бүтэц
+
+- [Байгууллага](./src/lib/db/schema/company.md)
+- [Агуулах](./src/lib/db/schema/warehouse.schema.ts)
+
+## 🤝 Contributing
+
+1. Follow the code standards and patterns
+2. Update documentation when making changes
+3. Write tests for new features
+4. Use TypeBox for validation
+5. Follow the domain-driven structure
+
+## 📄 License
+
+[Add your license information here]
 
-## Баазийн бүтэц
+---
 
-- [Байгууллага](./src/lib/db/schema/merchant.md)
-- [Агуулах](./src/lib/db/schema/inventory.md)
+For detailed documentation, see the [docs](./docs/) directory.