Project Directory Structure

12003

1. JianghuJS Project Structure

├── app 
│   ├── common                                       # Common tools, static methods, etc. for the project    
│   ├── constant                                     # Constants   
│   │   ├── constant.js
│   │   └── error.js
│   ├── controller                                   # Controllers for exposed interfaces 
│   ├── public                                      # Static resources directory 
│   ├── schedule                                     # Scheduled tasks; refer to https://www.eggjs.org/en/basics/schedule
│   ├── service                                      # Application protocol service directory
│   └── view                                         # Directory for storing pages
├── config                                           # Egg configuration
│   ├── config.default.js                           # Default configuration                    
│   ├── config.local.js                             # Configuration used during npm run dev
│   ├── config.prod.js                              # Configuration used during npm run start
│   ├── config.unittest.js                          # Configuration used during npm run test
│   └── plugin.js                                   # Egg plugin configuration
├── app.js                                          # Custom initialization work during startup
├── jsconfig.json                                   # File for configuring JavaScript project syntax checking, IntelliSense, etc.
├── package.json                                    # Project dependencies and configuration file
├── sql                                             # Directory for SQL files
│   └── init.sql                                    # Initialization SQL file
└── upload                                          # Directory for saving uploaded files

2. Description of Each Directory

• app: Main code directory for the application
  • common: Contains common tools, static methods, etc.
  • constant: Contains constant definitions
    • constant.js: Constant definition file
    • error.js: Error message definition file
  • controller: Contains controllers for exposed interfaces
  • public: Static resources directory
  • schedule: Contains scheduled tasks
  • service: Directory for application protocol services
  • view: Directory for storing pages
• config: Contains configuration files
  • config.default.js: Default configuration file
  • config.local.js: Configuration file used during npm run dev
  • config.prod.js: Configuration file used during npm run start
  • config.unittest.js: Configuration file used during npm run test
  • plugin.js: Plugin configuration file
• app.js: Entry file for custom initialization work during startup
• jsconfig.json: File for configuring JavaScript project syntax checking, IntelliSense, etc.
• package.json: Project dependencies and configuration file
• sql: Directory for SQL files
• init.sql: Initialization SQL file
• upload: Directory for uploaded files