@ecopex/ecopex-framework 1.0.0

package/.env

@@ -0,0 +1,73 @@
+# ===========================================
+# SB System Environment Configuration
+# ===========================================
+
+# Application Environment
+NODE_ENV=development
+LOG_LEVEL=error
+
+# Server Configuration
+HOST=0.0.0.0
+API_PORT=3000
+ADMIN_PORT=3001
+
+# Database Configuration
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=Gs1905ua
+DB_NAME=ecommerce
+
+# Alternative: Use DATABASE_URL for production
+# DATABASE_URL=mysql://username:password@host:port/database
+
+# CORS Configuration
+CORS_ORIGIN=*
+
+# PM2 Process Management
+API_INSTANCES=1
+API_EXEC_MODE=fork
+ADMIN_INSTANCES=1
+ADMIN_EXEC_MODE=fork
+
+# Internationalization
+DEFAULT_LOCALE=en
+SUPPORTED_LOCALES=en,tr,es
+
+# Security (for production)
+# JWT_SECRET=your_jwt_secret_here
+# BCRYPT_ROUNDS=12
+# SESSION_SECRET=your_session_secret_here
+
+# Redis (for caching/sessions)
+# REDIS_HOST=localhost
+# REDIS_PORT=6379
+# REDIS_PASSWORD=
+
+# Email Configuration (for notifications)
+# SMTP_HOST=smtp.gmail.com
+# SMTP_PORT=587
+# SMTP_USER=your_email@gmail.com
+# SMTP_PASS=your_app_password
+# FROM_EMAIL=noreply@yoursystem.com
+
+# File Upload Configuration
+# UPLOAD_MAX_SIZE=10485760
+# UPLOAD_ALLOWED_TYPES=image/jpeg,image/png,image/gif,application/pdf
+
+# Rate Limiting
+# RATE_LIMIT_WINDOW_MS=900000
+# RATE_LIMIT_MAX_REQUESTS=100
+
+# Logging
+# LOG_FILE_PATH=./logs/app.log
+# LOG_MAX_SIZE=10m
+# LOG_MAX_FILES=5
+
+# Monitoring
+# HEALTH_CHECK_INTERVAL=30000
+# METRICS_ENABLED=true
+
+# Development Tools
+# DEBUG=sb_system:*
+# NODE_OPTIONS=--max-old-space-size=4096

package/README.md

@@ -0,0 +1,248 @@
+# SB System
+
+A Node.js system built with Fastify, Knex, and Ajv for automatic routing and database management with PM2 process management.
+
+## Features
+
+- **Fastify**: High-performance web framework
+- **Knex**: SQL query builder with migrations and seeds
+- **Ajv**: JSON schema validation
+- **MySQL**: Database support
+- **PM2**: Process management for production
+- **Microservices**: Separate admin and API services
+- **Automatic Routing**: Dynamic route loading from directory structure
+
+## Project Structure
+
+```
+sb_system/
+├── workers/
+│   ├── admin.js             # Admin service worker
+│   └── api.js               # API service worker
+├── routes/
+│   ├── admin/
+│   │   └── users/
+│   │       ├── route.js      # Route definitions
+│   │       ├── handler.js    # Route handlers
+│   │       └── validation.js # Validation schemas
+│   └── api/
+├── database/
+│   ├── migrations/
+│   └── seeds/
+├── config/
+│   └── database.js
+├── utils/
+│   ├── routeLoader.js
+│   └── validator.js
+├── logs/                    # PM2 log files
+├── ecosystem.config.js     # PM2 configuration
+└── package.json
+```
+
+## Installation
+
+1. Install dependencies:
+```bash
+npm install
+```
+
+2. Set up environment variables:
+```bash
+# Copy the example and configure your settings
+cp env.example .env
+```
+
+3. Configure your environment in `.env`:
+```bash
+# Database Configuration
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=your_username
+DB_PASSWORD=your_password
+DB_NAME=sb_system
+
+# Server Configuration
+API_PORT=3000
+ADMIN_PORT=3001
+HOST=0.0.0.0
+
+# Optional: Internationalization
+DEFAULT_LOCALE=en
+SUPPORTED_LOCALES=en,tr,es
+```
+
+4. Run database migrations:
+```bash
+npm run migrate
+```
+
+5. Seed the database (optional):
+```bash
+npm run seed
+```
+
+> **Note**: See [ENVIRONMENT.md](./ENVIRONMENT.md) for complete environment variable documentation.
+
+## Usage
+
+### Development
+```bash
+# Start both services with PM2
+npm run dev
+
+# Or start individual services for development
+npm run dev:api      # API service only
+npm run dev:admin    # Admin service only
+```
+
+### Production
+```bash
+# Start all services
+npm start
+
+# Or start with production environment
+npm run prod
+```
+
+### PM2 Management
+```bash
+# View status
+npm run status
+
+# View logs
+npm run logs
+
+# Restart services
+npm run restart
+
+# Stop services
+npm run stop
+
+# Reload services (zero-downtime)
+npm run reload
+
+# Delete all services
+npm run delete
+```
+
+## Services
+
+### API Service (Port 3000)
+- **Health Check**: `GET http://localhost:3000/health`
+- **Documentation**: `GET http://localhost:3000/docs`
+- **Welcome**: `GET http://localhost:3000/`
+- **Language Management**:
+  - `GET /api/language` - Get supported languages
+  - `POST /api/language/set` - Set preferred language
+  - `GET /api/language/detect` - Detect language from headers
+
+### Admin Service (Port 3001)
+- **Health Check**: `GET http://localhost:3001/health`
+- **Documentation**: `GET http://localhost:3001/docs`
+- **User Management**:
+  - `GET /admin/users` - Get all users (with pagination)
+  - `GET /admin/users/:id` - Get user by ID
+  - `POST /admin/users` - Create new user
+  - `PUT /admin/users/:id` - Update user
+  - `DELETE /admin/users/:id` - Delete user
+
+## Adding New Routes
+
+1. Create a new directory under `routes/admin/` or `routes/api/`
+2. Add three files:
+   - `route.js` - Define your routes
+   - `handler.js` - Implement route handlers
+   - `validation.js` - Define validation schemas
+
+### Example Route Structure
+
+```javascript
+// routes/admin/products/route.js
+module.exports = [
+  {
+    method: 'GET',
+    url: '',
+    handlerName: 'getAllProducts',
+    validationName: 'getAllProductsValidation',
+    schema: {
+      // Fastify schema definition
+    }
+  }
+];
+
+// routes/admin/products/handler.js
+class ProductHandler {
+  static async getAllProducts(request, reply) {
+    // Handler implementation
+  }
+}
+
+module.exports = ProductHandler;
+
+// routes/admin/products/validation.js
+module.exports = {
+  getAllProductsValidation: {
+    // Ajv validation schema
+  }
+};
+```
+
+## Database
+
+The system uses Knex.js for database operations with MySQL. Migrations and seeds are included for easy setup.
+
+### Available Commands
+- `npm run migrate` - Run migrations
+- `npm run migrate:rollback` - Rollback migrations
+- `npm run seed` - Run seeds
+
+## Multi-Language Support
+
+The system includes comprehensive internationalization (i18n) support with automatic language detection and validation error translation.
+
+### Supported Languages
+- **English (en)** - Default
+- **Turkish (tr)** - Türkçe
+- **Spanish (es)** - Español
+
+### Language Detection
+The system automatically detects language from:
+1. `Accept-Language` header
+2. `X-Language` header
+3. `lang` query parameter
+4. Falls back to default locale
+
+### Language Endpoints
+```bash
+# Get supported languages
+GET /api/language
+
+# Set preferred language
+POST /api/language/set
+{
+  "language": "tr"
+}
+
+# Detect language from headers
+GET /api/language/detect
+```
+
+### Usage Examples
+```bash
+# Request with Turkish language
+curl -H "Accept-Language: tr" http://localhost:3000/api/language
+
+# Request with custom language header
+curl -H "X-Language: es" http://localhost:3000/admin/users
+
+# Request with query parameter
+curl "http://localhost:3000/admin/users?lang=tr"
+```
+
+## Validation
+
+The system uses Ajv for JSON schema validation with multi-language error messages. Validation schemas are defined in the `validation.js` files and automatically applied to routes.
+
+## License
+
+MIT

package/config/swagger/admin.js

@@ -0,0 +1,44 @@
+/**
+ * Swagger configuration for Admin service
+ */
+module.exports = {
+  swagger: {
+    openapi: {
+      info: {
+        title: 'Ecommerce Admin API',
+        description: 'Admin API documentation for Ecommerce',
+        version: '1.0.0'
+      },
+      host: `${process.env.HOST || 'localhost'}:${process.env.ADMIN_PORT || 3001}`,
+      schemes: ['http', 'https'],
+      consumes: ['application/json'],
+      produces: ['application/json'],
+      components: {
+        securitySchemes: {
+          bearer: {
+            type: 'http',
+            scheme: 'bearer',
+            bearerFormat: 'JWT',
+            description: 'Enter the token with the `Bearer: ` prefix, e.g. "Bearer abcde12345".'
+          },
+          apiKey: {
+            type: 'apiKey',
+            in: 'header',
+            name: 'apiKey',
+            description: 'Enter token e.g. "abcde1-234533-333312-2222".'
+          }
+        },
+        headers: {
+          description: 'Headers',
+          scheme: {
+            type: 'object',
+            properties: {}
+          }
+        }
+      }
+    }
+  },
+  swaggerUi: {
+    routePrefix: '/docs'
+  }
+};

package/config/swagger/api.js

@@ -0,0 +1,19 @@
+/**
+ * Swagger configuration for API service
+ */
+module.exports = {
+  swagger: {
+    info: {
+      title: 'SB System API',
+      description: 'API documentation for SB System',
+      version: '1.0.0'
+    },
+    host: `${process.env.HOST || 'localhost'}:${process.env.API_PORT || 3000}`,
+    schemes: ['http', 'https'],
+    consumes: ['application/json'],
+    produces: ['application/json']
+  },
+  swaggerUi: {
+    routePrefix: '/docs'
+  }
+};

package/database/migrations/20240000135243_timezones.js

@@ -0,0 +1,22 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('timezones', function(table) {
+        // Primary key
+        table.increments('timezone_id').primary();
+        table.string('name', 100).notNullable();
+        table.string('code', 100).notNullable();
+        table.string('offset', 100).notNullable();
+        table.string('gmt', 100).notNullable();
+    });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+    return knex.schema.dropTable('timezones');
+};

package/database/migrations/20240000135244_countries.js

@@ -0,0 +1,23 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('countries', function(table) {
+        // Primary key
+        table.increments('country_id').primary();
+        table.string('name', 100).notNullable();
+        table.string('code', 100).notNullable();
+        table.string('iso_code', 100).notNullable();
+        table.string('phone_code', 100).notNullable();
+        table.string('flag', 100).notNullable();
+    });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+    return knex.schema.dropTable('countries');
+};

package/database/migrations/20240000135244_create_admins_table.js

@@ -0,0 +1,66 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+  return knex.schema.createTable('admins', function(table) {
+    // Primary key
+    table.increments('admin_id').primary();
+    table.integer('country_id').unsigned().references('country_id').inTable('countries');
+    
+    // Basic admin information
+    table.string('firstname', 100).nullable();
+    table.string('lastname', 100).nullable();
+    table.string('username', 100).notNullable().unique();
+    table.string('email', 255).nullable().unique();
+    table.string('password', 255).notNullable();
+    table.enum('role', ['admin', 'manager']).defaultTo('manager');
+    
+    // Two-factor authentication fields
+    table.boolean('two_factor_enabled').defaultTo(false);
+    table.string('two_factor_secret', 32).nullable(); // TOTP secret
+    table.string('phone_number', 20).nullable();
+    table.boolean('phone_verified').defaultTo(false);
+    table.boolean('email_verified').defaultTo(false);
+    
+    // Login security
+    table.integer('login_attempts').defaultTo(0);
+    table.timestamp('locked_until').nullable();
+    
+    // Password security
+    table.timestamp('password_changed_at').nullable();
+    table.string('password_reset_token', 255).nullable();
+    
+    // Email verification
+    table.string('email_verification_token', 255).nullable();
+    
+    // Phone verification
+    table.string('phone_verification_code', 10).nullable();
+
+    // Address information
+    table.string('address', 255).nullable();
+    table.string('city', 100).nullable();
+    table.string('state', 100).nullable();
+    table.string('zip', 20).nullable();
+    
+    // Status and timestamps
+    table.boolean('is_active').defaultTo(true);
+    
+    // Audit timestamps
+    table.timestamps(true, true); // created_at and updated_at
+    
+    // Indexes for performance
+    table.index(['role']);
+    table.index(['is_active']);
+    table.index(['two_factor_enabled']);
+    table.index(['created_at']);
+  });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+  return knex.schema.dropTable('admins');
+};

package/database/migrations/20240000135244_currencies.js

@@ -0,0 +1,21 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('currencies', function(table) {
+        // Primary key
+        table.increments('currency_id').primary();
+        table.string('name', 100).notNullable();
+        table.string('code', 100).notNullable();
+        table.string('symbol', 100).notNullable();
+    });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+    return knex.schema.dropTable('currencies');
+};

package/database/migrations/20240000135244_languages.js

@@ -0,0 +1,21 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('languages', function(table) {
+        // Primary key
+        table.increments('language_id').primary();
+        table.string('name', 100).notNullable();
+        table.string('code', 100).notNullable();
+        table.string('flag', 100).notNullable();
+    });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+    return knex.schema.dropTable('languages');
+};

package/database/migrations/20240000135244_taxes.js

@@ -0,0 +1,10 @@
+
+exports.up = knex =>
+    knex.schema.createTable('taxes', table => {
+        table.increments('tax_id').primary();
+        table.string('name').notNullable();
+        table.decimal('rate', 5, 2).notNullable();
+    });
+
+exports.down = knex =>
+    knex.schema.dropTable('taxes');

package/database/migrations/20240000135245_sites.js

@@ -0,0 +1,37 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('sites', function(table) {
+        table.increments('site_id').primary();
+        table.integer('admin_id').unsigned().references('admin_id').inTable('admins');
+        table.integer('currency_id').unsigned().references('currency_id').inTable('currencies');
+        table.integer('timezone_id').unsigned().references('timezone_id').inTable('timezones');
+        table.integer('language_id').unsigned().references('language_id').inTable('languages');
+        table.integer('country_id').unsigned().references('country_id').inTable('countries');
+        table.integer('tax_id').unsigned().references('tax_id').inTable('taxes');
+        table.string('name', 100).notNullable();
+        table.string('domain', 100).notNullable().unique();
+        table.string('logo', 100).notNullable();
+        table.string('favicon', 100).notNullable();
+        table.string('description', 100).notNullable();
+        table.string('keywords', 100).notNullable();
+        table.boolean('is_active').defaultTo(true);
+        table.datetime('expires_at').notNullable();
+        table.timestamps(true, true);
+        table.index(['admin_id'], 'site_admin_id_index');
+        table.index(['name'], 'site_name_index');
+        table.index(['domain'], 'site_domain_index');
+        table.index(['created_at'], 'site_created_at_index');
+        table.index(['updated_at'], 'site_updated_at_index');
+    });
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function(knex) {
+    return knex.schema.dropTable('sites');
+};

package/database/migrations/20240000135246_payment_methods.js

@@ -0,0 +1,33 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = knex => knex.schema.createTable('payment_methods', function(table) {
+        // Primary key
+        table.increments('payment_method_id').primary();
+        table.integer('site_id').unsigned().references('site_id').inTable('sites');
+        table.integer('currency_id').unsigned().references('currency_id').inTable('currencies');
+        table.string('logo').defaultTo(null);
+        table.string('name').notNullable();
+        table.string('code').unique().notNullable();
+        table.string('provider').defaultTo(null);
+        table.string('api_key').defaultTo(null);
+        table.string('api_secret').defaultTo(null);
+        table.string('api_url').defaultTo(null);
+        table.string('api_version').defaultTo(null);
+        table.boolean('is_active').defaultTo(true);
+        table.timestamps(true, true);
+    }).createTable('payment_method_translations', table => {
+        table.increments('payment_method_translation_id').primary();
+        table.integer('payment_method_id').unsigned().references('payment_method_id').inTable('payment_methods').onDelete('CASCADE');
+        table.integer('language_id').unsigned().references('language_id').inTable('languages');
+        table.string('description').notNullable();
+    });
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = knex =>
+    knex.schema.dropTable('payment_method_translations')
+        .dropTable('payment_methods');

package/database/migrations/20251016113547_devices.js

@@ -0,0 +1,37 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function(knex) {
+    return knex.schema.createTable('devices', function (table) {
+        table.increments('device_id').unsigned().notNullable().primary();
+        table.integer('personal_id');
+        table.enum('personal_type', ['admin', 'site', 'user']).notNullable();
+        table.string('unique_id', 100).notNullable();
+        table.string('ip_address', 100).notNullable();
+        table.text('device_information').notNullable();
+        table.boolean('two_factor_approved').defaultTo(false);
+        table.string('token', 255).notNullable();
+        table.datetime('last_login_at').notNullable();
+        table.string('last_login_ip', 100).notNullable();
+        table.datetime('created_at').notNullable().defaultTo(knex.fn.now());
+        table.datetime('updated_at').notNullable().defaultTo(knex.raw('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'));
+        table.unique(['unique_id', 'personal_id', 'personal_type'], 'device_unique_index')
+        table.index(['personal_id', 'personal_type'], 'device_personal_index')
+        table.index(['token'], 'device_token_index')
+    })
+};
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function(knex) {
+    if (process.env.NODE_ENV === 'production') {
+        throw new Error('Cannot drop table in production environment.')
+    } else {
+        if(await knex.schema.hasTable('devices')) {
+            return knex.schema.dropTable('devices');
+        }
+    }
+};