1. Project Overview

PUPA

Chrysalis, the Beginning of Transformation

　　A database-driven code generation tool that generates content using online templates. It features multi-project management, team collaboration, multi-data-source management, custom configurations, and more.

2. Open Source License

Licensed under MIT

3. Screenshots

4. Feature Overview

An online code generator that generates code in various programming languages from database tables. It supports multiple template languages and data sources, highly flexible custom extension parameters, intuitive parameter viewing, and a convenient online template editing experience. It also provides multi-project management and team collaboration features to help standardize coding practices across teams. All configurations can be adjusted online and take effect immediately.

System Architecture

 

Features:

• Platform-based architecture: Manage multiple projects with a single deployment for long-term use.

• Lightweight: Uses a standalone MVC project structure without requiring additional dependencies, making deployment simpler.

• Supports team sharing to standardize code.

• Supports multiple data sources and various database types (MySQL, Maria, SQL Server, Oracle, PostgreSQL, with support for extensions).

• Supports multiple template engines (Enjoy, Freemarker, Vilocity, with support for extensions).

• Supports generating multiple language data type mappings simultaneously, such as code with matching Java and TypeScript data types.

• The online template editor uses the Monaco control, providing an experience very similar to Visual Studio Code.

• Supports custom parameter extensions at the project, member, data source, table, and field levels, ready to use immediately after configuration.

• Available parameters can be viewed at any time, making them clear and easy to understand.

• Projects and configurations can be cloned directly for quick customization.

• Supports importing and exporting projects and configurations, making migration effortless.

5. Tech Stack

Environment, Frameworks, and Components:

• JDK Version: JDK 1.8

• Database: MySQL 5.7.3

• Framework: Spring-boot-web

• Login Management: sa-token 1.34.0

• Frontend UI Framework: Layuimini 2.5.5 Single-Page Mode (jQuery + Html5)

• Editor Component: Monaco Editor

Deployment

1. Ensure that Java 1.8+ and a MySQL database are installed on the server. Run resources/sql/pupa.sql from the project directory in the database to initialize the data;

2. Modify the datasource database connection settings in the project configuration file resources/application.yml;

3. Modify the serverPath parameter in the frontend configuration file static/js/common/common.js to point to the corresponding server address;

4. Build the project;

5. Copy target/pupa-1.0-SNAPSHOT.java from the project directory to a custom directory on the server;

6. You can now start the service directly using server commands or use the provided script. Follow these steps:

1. Rename the JAR file to pupa.jar;

2. Copy resources/run/start.sh from the project directory to the server, placing it in the same directory as the JAR file;

3. Navigate to the project directory on the server and execute ./start.sh to start the project. If start.sh does not have execution permissions, run chmod u+x start.sh to grant permission, then start the project;

4. Enter the actual project address in your browser to access it, for example: http://192.168.0.1:7384.

Default administrator username and password: admin 123456

Detailed content please refer to README.md document