ra-data-postgrest 项目教程

ra-data-postgrest 项目教程

ra-data-postgrestreact admin client for postgREST项目地址:https://gitcode.com/gh_mirrors/ra/ra-data-postgrest

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

ra-data-postgrest/
├── src/
│   ├── index.ts
│   ├── dataProvider.ts
│   ├── authProvider.ts
│   ├── utils.ts
│   └── types.ts
├── tests/
│   ├── dataProvider.test.ts
│   ├── authProvider.test.ts
│   └── utils.test.ts
├── .gitignore
├── .prettierrc.js
├── CHANGELOG.md
├── LICENSE
├── README.md
├── jest.config.js
├── package-lock.json
├── package.json
├── tsconfig.base.json
└── tsconfig.json

目录结构介绍

• src/: 包含项目的主要源代码文件。
  • index.ts: 项目的入口文件。
  • dataProvider.ts: 数据提供者实现文件。
  • authProvider.ts: 认证提供者实现文件。
  • utils.ts: 工具函数文件。
  • types.ts: 类型定义文件。
• tests/: 包含项目的单元测试文件。
  • dataProvider.test.ts: 数据提供者的单元测试文件。
  • authProvider.test.ts: 认证提供者的单元测试文件。
  • utils.test.ts: 工具函数的单元测试文件。
• .gitignore: Git忽略文件配置。
• .prettierrc.js: Prettier代码格式化配置文件。
• CHANGELOG.md: 项目更新日志文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• jest.config.js: Jest测试配置文件。
• package-lock.json: npm包锁定文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.base.json: TypeScript基础配置文件。
• tsconfig.json: TypeScript项目配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，该文件是整个项目的入口点，负责导出数据提供者和认证提供者。

// src/index.ts
import dataProvider from './dataProvider';
import authProvider from './authProvider';

export { dataProvider, authProvider };

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "@raphiniert/ra-data-postgrest",
  "version": "2.3.0",
  "description": "PostgREST Data Provider for react-admin",
  "main": "src/index.ts",
  "scripts": {
    "test": "jest",
    "build": "tsc",
    "lint": "eslint src --ext .ts,.tsx"
  },
  "dependencies": {
    "axios": "^0.21.1",
    "query-string": "^6.13.7"
  },
  "devDependencies": {
    "@types/jest": "^26.0.23",
    "eslint": "^7.27.0",
    "jest": "^26.6.3",
    "prettier": "^2.3.0",
    "typescript": "^4.2.4"
  },
  "license": "MIT"
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项和文件包含规则。

{
  "extends": "./tsconfig.base.json",
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  },
  "include": ["src"]
}

.prettierrc.js

.prettierrc.js 文件是 Prettier 代码格式化工具的配置文件。

module.exports = {
  singleQuote: true,
  trailingComma: 'all',
  printWidth: 80,
};

通过以上介绍，您应该对 `ra-data-postg

ra-data-postgrestreact admin client for postgREST项目地址:https://gitcode.com/gh_mirrors/ra/ra-data-postgrest