Maxun开源项目使用教程

Maxun开源项目使用教程

maxun 🔥Open Source No Code Web Data Extraction Platform. Turn Websites To APIs & Spreadsheets With No-Code Robots In Minutes🔥 项目地址: https://gitcode.com/gh_mirrors/ma/maxun

1. 项目目录结构及介绍

Maxun项目是一个开源的无代码网页数据抓取平台。以下是项目的目录结构及其简要介绍：

maxun/
├── .github/              # GitHub相关配置文件
├── maxun-core/           # 项目核心代码
├── perf/                 # 性能测试相关代码
├── public/               # 公共静态资源文件
├── server/               # 服务器相关配置和代码
├── src/                  # 源代码目录
├── .dockerignore         # Docker构建时需要忽略的文件
├── .gitignore            # Git需要忽略的文件
├── .sequelizerc          # Sequelize配置文件
├── Dockerfile            # Docker构建文件
├── ENVEXAMPLE            # 环境变量示例文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── docker-compose.yml    # Docker Compose配置文件
├── docker-entrypoint.sh  # Docker启动脚本
├── index.html            # 默认HTML文件
├── nginx.conf            # Nginx配置文件
├── package.json          # 项目包配置文件
├── tsconfig.json         # TypeScript配置文件
├── typedoc.json          # TypeDoc配置文件
└── vite.config.js        # Vite配置文件

2. 项目的启动文件介绍

项目的启动主要涉及两个文件：docker-compose.yml 和 ENVEXAMPLE。

• docker-compose.yml：这是一个用于定义和运行多容器Docker应用的配置文件。它包含了项目的所有服务，如前端、后端、数据库等，以及它们之间的关联和配置。使用以下命令启动项目：

  docker-compose up -d
  

• ENVEXAMPLE：这个文件提供了项目所需的环境变量的示例。你需要创建一个名为.env的文件，并将ENVEXAMPLE中的内容复制到.env文件中，然后根据实际情况进行配置。

3. 项目的配置文件介绍

项目配置主要通过.env文件进行，以下是一些重要的环境变量及其描述：

• BACKEND_PORT：后端运行端口。
• FRONTEND_PORT：前端运行端口。
• BACKEND_URL：后端URL地址。
• VITE_BACKEND_URL：前端连接后端时使用的URL地址。
• PUBLIC_URL：前端运行URL地址。
• VITE_PUBLIC_URL：后端连接前端时使用的URL地址。
• JWT_SECRET：用于签名和验证JWT的密钥。
• DB_NAME、DB_USER、DB_PASSWORD、DB_HOST、DB_PORT：PostgreSQL数据库配置。
• ENCRYPTION_KEY：用于加密敏感数据的密钥。
• MINIO_ENDPOINT、MINIO_PORT、MINIO_ACCESS_KEY：MinIO存储配置。

确保正确配置这些环境变量，否则相关功能可能无法正常工作。

maxun 🔥Open Source No Code Web Data Extraction Platform. Turn Websites To APIs & Spreadsheets With No-Code Robots In Minutes🔥 项目地址: https://gitcode.com/gh_mirrors/ma/maxun