JamBrain 项目使用教程

1. 项目目录结构及介绍

JamBrain 项目的目录结构如下：

JamBrain/
├── public-api/
├── public-jammer-bio/
├── public-jammer-vg/
├── public-ludumdare-com/
├── public-static/
├── public-url-shortener/
├── sandbox/
├── scripts/
├── src/
├── .eslintignore
├── .gitattributes
├── .gitignore
├── .npmrc
├── .stylelintignore
├── .travis.yml
├── LICENSE.md
├── Makefile
├── README.md
└── package.json

目录介绍

• public-api/：包含 Restful API 调用的代码，访问地址为 https://api.ldjam.com。
• public-jammer-bio/：包含用户页面的代码，访问地址为 https://jammer.bio。
• public-jammer-vg/：包含通用版本的站点代码，访问地址为 https://jammer.vg。
• public-ludumdare-com/：包含 Ludum Dare 游戏活动站点的代码，访问地址为 https://ldjam.com。
• public-static/：存放静态文件，如图片等，访问地址为 https://static.jam.vg。
• public-url-shortener/：包含 URL 缩短服务的代码，访问地址为 https://ldj.am 和 https://jam.mr。
• sandbox/：存放旧代码、实验代码和调试工具。
• scripts/：包含项目的脚本文件。
• src/：包含项目的源代码，包括 PHP、JavaScript、CSS 等。
• .eslintignore：ESLint 忽略文件。
• .gitattributes：Git 属性配置文件。
• .gitignore：Git 忽略文件。
• .npmrc：npm 配置文件。
• .stylelintignore：Stylelint 忽略文件。
• .travis.yml：Travis CI 配置文件。
• LICENSE.md：项目许可证文件。
• Makefile：项目的核心构建脚本。
• README.md：项目说明文件。
• package.json：npm 包配置文件。

2. 项目启动文件介绍

JamBrain 项目的启动文件主要集中在 src/ 目录下。以下是一些关键的启动文件：

• src/index.php：项目的入口文件，负责初始化项目并加载必要的依赖。
• src/config.php：项目的配置文件，包含数据库连接、API 密钥等配置信息。
• src/router.php：路由文件，负责处理 URL 请求并将其映射到相应的控制器。

3. 项目的配置文件介绍

JamBrain 项目的配置文件主要包括以下几个：

• .env：环境变量配置文件，包含数据库连接信息、API 密钥等敏感信息。
• config.php：项目的核心配置文件，包含数据库连接、API 密钥、缓存配置等。
• .npmrc：npm 配置文件，包含 npm 注册表、代理等配置。
• .travis.yml：Travis CI 配置文件，包含 CI/CD 流程的配置。
• Makefile：项目的核心构建脚本，包含编译、清理、测试等命令。

通过以上配置文件，可以灵活地调整项目的运行环境和构建流程。