---

NexERP Backend

Project Overview

NexERP is an Enterprise Resource Planning (ERP) solution designed for SMEs. It integrates core business processes—including Human Resources, Inventory, and Logistics—into a single platform, providing data-driven insights through automated KPI dashboards.

👥 Team Members

Name	Wonjin Lee	Minseob Yun	Chaeyeon Kwak
Role	BE Lead	BE, INFRA	BE, FE

---

Tech Stack

Development & Infrastructure

Collaboration

Database Entity Relationship Diagram (ERD)

---

Key Features

Authentication & Security

• JWT-based Auth: Secure authentication with role-based permission routing.
• Granular Permissions: Management of Department (Admin/Inventory/Logistics) and detailed Roles (READ/WRITE/ALL).

Domain APIs

• Personnel Management (Role assignment, User approval)
• Project Management (Task allocation, Approval, Overall administration)
• Inbound Operations Management (Approval requests, Goods receiving, Management)
• Outbound Operations Management (Approval requests, Shipment processing, Management)
• Inventory Management (Registration, Search, Safety/Target stock level configuration)

KPI Dashboard

• Project Completion Rate
• Long-Term Task Processing Rate
• Safety Stock Fulfillment Rate
• Inventory Turnover Ratio
• Shipment Completion Rate
• Shipment Lead Time
• Forecasted KPIs (Inventory Turnover Ratio, Shipment Lead Time)

Swagger

---

📁 Key File Structure

nexerp
├─ domain
│  ├─ admin
│  ├─ analytics
│  ├─ company
│  ├─ inventory
│  ├─ inventoryitem
│  ├─ item
│  ├─ kpi
│  ├─ logistics
│  ├─ logisticsItem
│  ├─ member
│  ├─ project
│  └─ projectmember
│
└─ global
   ├─ common
   ├─ config
   ├─ handler
   └─ security     
                      

---

🤝 Collaboration Rules

Issue Type Classification

Type	Description
[Feature]	New functional additions
[Refactor]	Code structure improvements without functional changes
[Proposal]	Suggestions for collaboration improvements
[Bug]	Bug fixes and issue resolutions
[Help]	Requests for assistance or clarification

Commit Message Convention

Structure

<Type>: <Title>

Body (optional)

• Each commit represents a single unit of work.

Commit Message Types

Type	Description
feature	Implementation of a new feature
refactor	Code refactoring (structural improvements without changing functionality)
fix	Bug fix
docs	Documentation updates (README, comments, wiki, etc.)
test	Addition or modification of test code
style	Code formatting changes
chore	Miscellaneous maintenance tasks (e.g., dependency updates)
comment	Adding or modifying comments
rename	Renaming or relocating files/folders
remove	File deletion
!BREAKING CHANGE	Major API changes that are not backward compatible
!HOTFIX	Critical or urgent bug fix

Commit Message Examples

feature: Implement login API  
refactor: Separate UserService logic

---

🌱 Git Branch Strategy

✅ Core Branches

Types

• main: Production deployment branch
• dev: Development integration branch

Protection Rules

• Direct commits or pushes to the main and dev branches are prohibited.
• All changes must be merged through a Pull Request (PR) after code review.

Working Branch Naming Convention

Branch Name Structure

<branch-type>/<issue-number>/<feature-name>

Branch Types

Type	Description
feature/issue-number/summary	Add a new feature
refactor/issue-number/summary	Code refactoring
fix/issue-number/summary	General bug fix
docs/issue-number/summary	Documentation updates (README, comments, wiki, etc.)
test/issue-number/summary	Add test code
chore/issue-number/summary	Maintenance tasks (e.g., dependency updates)
hotfix/issue-number/summary	Critical or urgent bug fix

Branch Name Examples

chore/1/github-initial-setup
fix/57/image-preview

PR & Issue Linking Rules

• When creating a PR, you must link the related issue.

e.g., Related issue: #3

---