AdminJS 开源项目教程

AdminJS 开源项目教程

adminjsAdminJS is an admin panel for apps written in node.js项目地址:https://gitcode.com/gh_mirrors/ad/adminjs

1. 项目的目录结构及介绍

AdminJS 是一个用于 Node.js 应用的自动管理界面生成器。以下是其基本的目录结构：

adminjs/
├── bin/
├── config/
├── docs/
├── examples/
├── lib/
├── node_modules/
├── scripts/
├── src/
│   ├── components/
│   ├── design-system/
│   ├── locale/
│   ├── plugins/
│   ├── resources/
│   ├── services/
│   ├── utils/
│   ├── adminjs.ts
│   ├── app.ts
│   ├── index.ts
│   └── server.ts
├── test/
├── .gitignore
├── .npmignore
├── .prettierrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

目录介绍

• bin/: 包含项目的可执行文件。
• config/: 包含项目的配置文件。
• docs/: 包含项目的文档。
• examples/: 包含示例应用。
• lib/: 包含编译后的 JavaScript 文件。
• node_modules/: 包含项目的依赖包。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的源代码。
  • components/: 包含 UI 组件。
  • design-system/: 包含设计系统相关的文件。
  • locale/: 包含国际化文件。
  • plugins/: 包含插件文件。
  • resources/: 包含资源文件。
  • services/: 包含服务文件。
  • utils/: 包含工具函数。
  • adminjs.ts: AdminJS 的主文件。
  • app.ts: 应用的主文件。
  • index.ts: 项目的入口文件。
  • server.ts: 服务器的主文件。
• test/: 包含测试文件。
• .gitignore: Git 忽略文件。
• .npmignore: npm 忽略文件。
• .prettierrc: Prettier 配置文件。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的介绍文档。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

AdminJS 的启动文件主要包括 src/index.ts 和 src/server.ts。

src/index.ts

这是项目的入口文件，负责初始化 AdminJS 并启动服务器。

import AdminJS from 'adminjs';
import AdminJSExpress from '@adminjs/express';
import express from 'express';

const adminJs = new AdminJS({
  databases: [],
  rootPath: '/admin',
});

const app = express();

const adminRouter = AdminJSExpress.buildRouter(adminJs);
app.use(adminJs.options.rootPath, adminRouter);

app.listen(3000, () => {
  console.log('AdminJS is under http://localhost:3000/admin');
});

src/server.ts

这个文件负责配置和启动 Express 服务器。

import express from 'express';
import AdminJS from 'adminjs';
import AdminJSExpress from '@adminjs/express';

const run = async () => {
  const app = express();

  const adminJs = new AdminJS({
    databases: [],
    rootPath: '/admin',
  });

  const adminRouter = AdminJSExpress.buildRouter(adminJs);
  app.use(adminJs.options.rootPath, adminRouter);

  app.listen(3000, () => {
    console.log('AdminJS is under http://localhost:3000/admin');
  });
};

run();

3. 项目的配置文件介绍

AdminJS 的配置文件主要包括 config/ 目录下的文件和 `

adminjsAdminJS is an admin panel for apps written in node.js项目地址:https://gitcode.com/gh_mirrors/ad/adminjs