Skip to content

reckless-sherixx/ERP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

52 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🏒 ERP System - Enterprise Resource Planning

Next.js TypeScript React License

πŸš€ A modern, full-stack Enterprise Resource Planning (ERP) system built with Next.js, TypeScript, and cutting-edge web technologies.


πŸ‘₯ Member Roles & Functionality

Our ERP system implements a comprehensive role-based access control (RBAC) system with five distinct user levels, each with specific permissions and capabilities:

πŸ”΄ System Admin - Ultimate System Control

Access Level: Full

Core Responsibilities:

  • πŸ›‘οΈ System Configuration: Manage global settings, security policies, and system parameters
  • πŸ‘‘ User Management: Create, modify, and delete all user accounts across all roles
  • πŸ”§ Module Management: Enable/disable ERP modules and configure system-wide features
  • πŸ’Ύ Database Management: Perform backups, maintenance, and data migration tasks
  • πŸ” Security Oversight: Manage security settings, audit logs, and compliance reports
  • 🏒 Multi-tenant Management: Configure and manage multiple organization instances

Key Capabilities:

  • Configuration of all system settings
  • Complete user management across all roles
  • System backups and maintenance
  • Global security and compliance management

🟠 Admin - Organization Management

Access Level: High

Core Responsibilities:

  • 🏒 Organization Setup: Configure company settings, departments, and organizational structure
  • πŸ‘₯ User Administration: Manage user accounts within their organization (except System Admin)
  • πŸ“‹ All Modules Access: Full access to all ERP modules and features
  • πŸ” Advanced Reporting: Generate comprehensive reports across all departments
  • πŸ’° Financial Oversight: Access all financial data, budgets, and financial reports
  • πŸ“Š Performance Monitoring: Track KPIs, productivity metrics, and organizational performance

Key Capabilities:

  • Access to all modules and features
  • Comprehensive reporting and analytics
  • User management (excluding System Admin)
  • Full organizational oversight

🟑 Factory Manager - Production Leadership

Access Level: Medium

Core Responsibilities:

  • 🏭 Production Management: Oversee manufacturing operations and production schedules
  • πŸ‘₯ Workforce Allocation: Assign staff to production tasks and manage work shifts
  • πŸ“Š Production Updates: Monitor and update production status and progress
  • πŸ”§ Resource Management: Manage production resources and equipment allocation
  • πŸ“ˆ Performance Tracking: Track production KPIs and efficiency metrics

Key Capabilities:

  • Production updates and monitoring
  • Workforce allocation and management
  • Manufacturing operations oversight

🟒 Inventory Manager - Stock Management

Access Level: Medium

Core Responsibilities:

  • πŸ“¦ Stock Management: Monitor inventory levels, track stock movements
  • πŸ›’ Procurement: Manage purchase orders and supplier relationships
  • πŸ“Š Usage Tracking: Track material usage and consumption patterns
  • πŸ” Inventory Analytics: Generate inventory reports and forecasting
  • ⚠️ Stock Alerts: Manage low stock alerts and reorder points

Key Capabilities:

  • Stock management and monitoring
  • Procurement and supplier management
  • Usage tracking and analytics

πŸ’Ό Sales Team - Customer Relations

Access Level: Medium

Core Responsibilities:

  • πŸ‘₯ Customer Management: Maintain customer database and relationships
  • πŸ“‹ Order Creation: Process sales orders and manage order lifecycle
  • πŸ’° Quotations: Create and manage customer quotations and proposals
  • πŸ“ˆ Sales Analytics: Track sales performance and customer metrics
  • 🀝 Client Communication: Manage customer communications and follow-ups

Key Capabilities:

  • Customer management and CRM
  • Order creation and processing
  • Quotation management and sales tracking

🎨 Design Team - Creative Management

Access Level: Medium

Core Responsibilities:

  • πŸ“ Design Upload: Upload and manage design files and specifications
  • πŸ“‹ Specification Management: Maintain product specifications and requirements
  • πŸ”„ Revision Tracking: Track design changes and version control
  • 🎯 Project Coordination: Coordinate with production and sales teams
  • πŸ“Š Design Analytics: Monitor design approval rates and timelines

Key Capabilities:

  • Design file upload and management
  • Specification management and tracking
  • Design revision control and versioning

πŸ’° Accounting - Financial Management

Access Level: Medium

Core Responsibilities:

  • 🧾 Invoicing: Create and manage customer invoices and billing
  • πŸ’³ Payment Tracking: Monitor payments, receivables, and outstanding amounts
  • πŸ“Š Financial Reporting: Generate financial reports and statements
  • πŸ” Expense Management: Track business expenses and cost analysis
  • πŸ“ˆ Financial Analytics: Provide financial insights and forecasting

Key Capabilities:

  • Invoicing and billing management
  • Payment tracking and monitoring
  • Financial reporting and analytics

πŸ”§ Production Staff - Operational Tasks

Access Level: Low

Core Responsibilities:

  • βœ… Task Updates: Update status of assigned production tasks
  • πŸ“ Material Logging: Log materials used in production processes
  • ⏰ Time Tracking: Record work hours and task completion times
  • πŸ“Š Progress Reporting: Report on task progress and completion
  • πŸ”§ Equipment Usage: Log equipment usage and maintenance needs

Key Capabilities:

  • Task status updates and progress tracking
  • Material usage logging and recording
  • Production data entry and reporting

πŸ‘₯ Customers - External Access

Access Level: Restricted

Core Responsibilities:

  • πŸ‘€ Order Viewing: View their order history and current order status
  • βœ… Design Approval: Approve or request changes to design proposals
  • πŸ“Š Production Progress: Track progress of their orders through production
  • πŸ’¬ Communication: Communicate with sales team regarding orders
  • πŸ“‹ Account Management: Manage their customer profile and preferences

Key Capabilities:

  • View orders and order history
  • Approve designs and specifications
  • Track production progress for their orders

πŸ” Permission Matrix

Feature System Admin Admin Factory Manager Inventory Manager Sales Team Design Team Accounting Production Staff Customers
System Configuration βœ… Full Control ❌ None ❌ None ❌ None ❌ None ❌ None ❌ None ❌ None ❌ None
User Management βœ… All Users βœ… Organization ❌ None ❌ None ❌ None ❌ None ❌ None ❌ None ❌ None
Production Management βœ… Full Access βœ… Full Access βœ… Updates & Allocation ❌ View Only ❌ View Only ❌ View Only ❌ View Only βœ… Task Updates βœ… Progress View
Inventory & Stock βœ… Full Access βœ… Full Access ❌ View Only βœ… Full Management ❌ View Only ❌ View Only ❌ View Only βœ… Log Usage ❌ None
Sales & CRM βœ… Full Access βœ… Full Access ❌ View Only ❌ View Only βœ… Full Management ❌ View Only ❌ View Only ❌ None βœ… View Orders
Design Management βœ… Full Access βœ… Full Access ❌ View Only ❌ View Only ❌ View Only βœ… Full Management ❌ View Only ❌ None βœ… Approve Designs
Financial Data βœ… Full Access βœ… Full Access ❌ Department ❌ Department ❌ Department ❌ Department βœ… Full Management ❌ None ❌ None
Reporting βœ… All Reports βœ… All Reports βœ… Production βœ… Inventory βœ… Sales βœ… Design βœ… Financial βœ… Task Reports βœ… Order Status
Data Modification βœ… All Data βœ… All Data βœ… Production Data βœ… Inventory Data βœ… Sales Data βœ… Design Data βœ… Financial Data βœ… Task Data βœ… Limited
Approval Authority βœ… All Levels βœ… Organization βœ… Production βœ… Procurement βœ… Sales Orders βœ… Design Changes βœ… Payments ❌ None βœ… Design Approval

πŸ›‘οΈ Security Features

  • Multi-Factor Authentication (MFA): Available for all roles
  • Session Management: Automatic timeout and concurrent session control
  • Audit Logging: Complete activity tracking for compliance
  • Data Encryption: End-to-end encryption for sensitive information
  • IP Restrictions: Role-based IP access control
  • Temporary Access: Time-limited access grants for external users

🎯 Project Overview

This ERP system is designed to streamline business operations by integrating various organizational processes into a single, unified platform. Built with modern web technologies, it provides a scalable, maintainable, and user-friendly solution for managing business resources efficiently.

✨ Key Features

  • πŸ“Š Dashboard Analytics - Real-time business insights and KPI tracking
  • πŸ‘₯ User Management - Role-based access control and authentication
  • πŸ“¦ Inventory Management - Track stock levels, orders, and suppliers
  • πŸ’° Financial Management - Accounting, invoicing, and financial reporting
  • πŸ›’ Sales & CRM - Customer relationship management and sales tracking
  • πŸ“‹ Project Management - Task assignment and progress tracking
  • πŸ“± Responsive Design - Optimized for desktop, tablet, and mobile devices
  • πŸ”’ Security First - Enterprise-grade security and data protection

πŸš€ Getting Started

πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18.0.0 or higher) - Download here
  • npm, yarn, pnpm, or bun package manager
  • Git for version control

⚑ Quick Installation

  1. Clone the repository

    git clone https://github.com/reckless-sherixx/ERP.git
    cd ERP
  2. Install dependencies

    npm install
    # or
    yarn install
    # or
    pnpm install
    # or
    bun install
  3. Set up environment variables

    cp .env.example .env.local
    # Edit .env.local with your configuration
  4. Run the development server

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev
  5. Open your browser

    Navigate to http://localhost:3000 to see your ERP system in action! πŸŽ‰


πŸ›  Tech Stack

Our ERP system is powered by a modern, enterprise-grade technology stack designed for performance, scalability, and developer experience:

Technology Purpose Version Benefits
Next.js Full-stack React framework 15.3.2 SSR, SSG, API routes, optimal performance
React UI component library 19.0 Latest features, improved performance
TypeScript Type-safe JavaScript 5.0+ Enhanced code quality and developer experience
Prisma Database ORM 5.0+ Type-safe database operations and migrations
PostgreSQL Relational database 16.0+ Enterprise-grade data storage and reliability
WebSockets Real-time communication Latest Live updates and collaborative features
Docker Containerization 24.0+ Consistent deployment and scalability
Tailwind CSS Utility-first CSS framework 3.x Rapid UI development and consistent styling
NextAuth.js Authentication Latest Secure, flexible authentication system

πŸ”₯ Advanced Features & Optimizations

πŸš€ Performance Enhancements

  • React 19 Concurrent Features: Improved rendering performance and user experience
  • Next.js 15.3.2 Turbopack: Lightning-fast development builds and hot reloading
  • Streaming SSR: Progressive page loading for better perceived performance
  • Automatic Code Splitting: Optimized bundle sizes for faster loading

πŸ”„ Real-time Capabilities

  • WebSocket Integration: Instant data synchronization across all connected clients
  • Live Collaboration: Real-time editing and updates without page refreshes
  • Push Notifications: Immediate alerts for critical business events
  • Live Analytics: Real-time dashboard updates and metrics

πŸ—„οΈ Database Excellence

  • Prisma ORM: Type-safe database operations with excellent developer experience
  • PostgreSQL: ACID compliance, complex queries, and enterprise reliability
  • Migration System: Version-controlled database schema evolution
  • Connection Pooling: Optimized database connections for high performance

🐳 Deployment & DevOps

  • Docker Multi-stage Builds: Optimized container images for production
  • Environment Isolation: Consistent behavior across development, staging, and production
  • Horizontal Scaling: Container orchestration ready for enterprise deployment
  • Health Checks: Built-in monitoring and auto-recovery capabilities

πŸ—‚ Key Files Description

  • src/app/page.tsx - Main application entry point
  • src/app/layout.tsx - Global layout and providers
  • next.config.ts - Next.js build and runtime configuration
  • prisma/schema.prisma - Database schema definition

🎨 Features & Functionality

πŸ“Š Core ERP Modules

  • User Authentication & Authorization

    • Secure login/logout functionality
    • Multi-tier role-based access control system
    • Session management with NextAuth.js
    • Granular permission management
  • Dashboard & Analytics

    • Real-time business metrics
    • Interactive charts and graphs
    • Customizable widget layouts
  • Inventory Management

    • Product catalog management
    • Stock level tracking
    • Supplier relationship management
    • Purchase order processing
  • Financial Management

    • Invoice generation and tracking
    • Expense management
    • Financial reporting and analytics
    • Budget planning tools
  • Customer Relationship Management (CRM)

    • Customer database management
    • Sales pipeline tracking
    • Communication history
    • Lead generation and conversion
  • Human Resources (Coming Soon)

    • Employee management
    • Payroll processing
    • Performance tracking
    • Leave management
  • Project Management (Coming Soon)

    • Task assignment and tracking
    • Timeline management
    • Resource allocation
    • Progress reporting

πŸ”§ Configuration & Customization

βš™οΈ Environment Variables

Create a .env.local file in the root directory:

# Database
DATABASE_URL="your_database_connection_string"

# Authentication
AUTH_SECRET="your_nextauth_secret"

# Database URL
DATABASE_URL="your_postgres_database_url"

#Oauth
AUTH_GOOGLE_ID="google_id"
AUTH_GOOGLE_SECRET="secret_key"

# API Keys
UPLOADTHING_TOKEN="your_uploadthing_token"
MAILTRAP_TOKEN="your_mailtrap_token"

#API Endpoints
NEXT_PUBLIC_API_URL="your_api_endpoint"
NEXT_PUBLIC_SOCKET_URL="your_socket_url"

#Port
SOCKET_PORT="your_socket_port"

# Email Service (optional)
EMAIL_SERVER_HOST="your_smtp_host"
EMAIL_SERVER_PORT=587
EMAIL_SERVER_USER="your_email_user"
EMAIL_SERVER_PASSWORD="your_email_password"

🎨 Customization Options

  • Theming: Modify tailwind.config.ts for custom colors and styling
  • Database: Configure your preferred database in prisma/schema.prisma
  • Authentication: Customize auth providers in src/lib/auth.ts
  • API Routes: Add custom endpoints in src/app/api/

πŸ— Contributing

We welcome contributions from the community! Here's how you can help:

🀝 How to Contribute

  1. Fork the repository

    git fork https://github.com/reckless-sherixx/ERP.git
  2. Create a feature branch

    git checkout -b feature/amazing-feature
  3. Make your changes

    • Follow the existing code style
    • Add tests for new features
    • Update documentation as needed
  4. Commit your changes

    git commit -m "feat: add amazing feature"
  5. Push to your fork

    git push origin feature/amazing-feature
  6. Create a Pull Request

    • Provide a clear description of your changes
    • Link any relevant issues
    • Ensure all tests pass

πŸ“‹ Development Guidelines

  • Code Style: Follow TypeScript and React best practices
  • Commits: Use conventional commit messages
  • Testing: Write tests for new features
  • Documentation: Update README and inline comments

🌟 Areas for Contribution

  • πŸ› Bug fixes and performance improvements
  • ✨ New ERP modules and features
  • πŸ“š Documentation improvements
  • 🎨 UI/UX enhancements
  • πŸ”§ DevOps and deployment optimizations

πŸš€ Deployment

🌐 Vercel (Recommended)

The easiest way to deploy your ERP system:

Deploy with Vercel

🐳 Docker

# Build the Docker image
docker build -t erp-system .

# Run the container
docker run -p 3000:3000 erp-system

☁️ Other Platforms

  • Netlify: Follow the Next.js deployment guide
  • Railway: One-click deployment with database included
  • DigitalOcean: Deploy on App Platform

πŸ“š Documentation & Resources

πŸ“– Learn More

πŸ“œ License & Credits

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Contributors


🌟 Support the Project

If you find this project helpful, please consider:

  • ⭐ Starring this repository
  • πŸ› Reporting bugs and issues
  • πŸ’‘ Suggesting new features
  • 🀝 Contributing code improvements
  • πŸ“’ Sharing with your network

Made with ❀️ by reckless-sherixx

Empowering businesses with modern ERP solutions

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages