Dashbling 开源项目教程

Dashbling 开源项目教程

dashblingHackable React based dashboards for developers, inspired by Dashing.项目地址:https://gitcode.com/gh_mirrors/da/dashbling

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

Dashbling 项目的目录结构如下：

dashbling/
├── docs/
│   └── getstarted.md
├── example/
│   └── example.jpg
├── hooks/
├── packages/
├── script/
├── .editorconfig
├── .gitignore
├── .prettierignore
├── .tool-versions
├── LICENSE
├── README.md
├── lerna.json
├── package.json
├── tsconfig.json
└── yarn.lock

目录介绍：

• docs/: 包含项目的文档文件，如入门指南 getstarted.md。
• example/: 包含示例文件，如 example.jpg。
• hooks/: 包含项目的钩子文件。
• packages/: 包含项目的包文件。
• script/: 包含项目的脚本文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• .tool-versions: 工具版本配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• lerna.json: Lerna 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Dashbling 项目的启动文件主要位于 package.json 中定义的脚本部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "webpack-dev-server --config webpack.config.js --mode development",
    "build": "webpack --config webpack.config.js --mode production",
    "test": "jest"
  }
}

启动脚本介绍：

• start: 启动开发服务器，使用 webpack-dev-server 进行热重载。
• build: 构建生产环境的代码，使用 webpack 进行打包。
• test: 运行测试，使用 jest 进行单元测试。

3. 项目的配置文件介绍

Dashbling 项目的关键配置文件包括：

• webpack.config.js: Webpack 配置文件，定义了如何打包和构建项目。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译选项。
• package.json: 项目依赖和脚本配置文件，包含了项目的依赖包和启动脚本。

webpack.config.js 配置文件介绍：

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: './src/index.html'
    })
  ]
};

tsconfig.json 配置文件介绍：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true
  },
  "include": [
    "./src/**/*"
  ]
}

package.json 配置文件介绍：

{
  "name": "dashbling",
  "version": "1.0.0",
  "description": "Hackable React based dashboards for developers",
  "main": "index.js",
  "scripts": {
    "start": "webpack-dev-server --config webpack.config.js --mode development",
    "build": "webpack --config webpack.config.js --mode production",
    "test": "jest"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  },
 

dashblingHackable React based dashboards for developers, inspired by Dashing.项目地址:https://gitcode.com/gh_mirrors/da/dashbling