CSS Speedrun 项目教程

2024-08-27 05:34:35作者：董灵辛Dennis

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

CSS Speedrun 项目的目录结构如下：

css-speedrun/
├── src/
│   ├── js/
│   │   └── puzzles/
│   ├── styles/
│   └── index.html
├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── webpack.config.js

目录结构介绍

src/：包含项目的源代码文件。
- js/：包含 JavaScript 文件，其中 puzzles/ 目录包含谜题的代码。
- styles/：包含项目的样式文件。
- index.html：项目的主 HTML 文件。
.gitignore：指定 Git 版本控制系统忽略的文件和目录。
LICENSE：项目的许可证文件，采用 MIT 许可证。
README.md：项目的说明文档。
package-lock.json：记录项目依赖的精确版本。
package.json：项目的配置文件，包含依赖和脚本命令。
webpack.config.js：Webpack 的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.html，这是项目的主 HTML 文件。它包含了页面的基本结构和加载必要的 JavaScript 和 CSS 文件。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>CSS Speedrun</title>
    <link rel="stylesheet" href="styles/main.scss">
</head>
<body>
    <div id="app"></div>
    <script src="js/main.js"></script>
</body>
</html>

启动文件介绍

<head> 部分包含了页面的元数据和加载的样式文件 styles/main.scss。
<body> 部分包含一个 div 元素，其 id 为 app，用于挂载应用程序的内容。
最后加载了 js/main.js 文件，这是项目的主 JavaScript 文件。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。

{
  "name": "css-speedrun",
  "version": "1.0.0",
  "description": "A small fun app to test your CSS knowledge",
  "main": "index.js",
  "scripts": {
    "build": "webpack --mode production",
    "watch": "webpack --mode development --watch"
  },
  "dependencies": {
    "webpack": "^5.0.0",
    "webpack-cli": "^4.0.0"
  },
  "license": "MIT"
}

配置文件介绍

name：项目的名称。
version：项目的版本号。
description：项目的描述。
main：项目的主入口文件。
scripts：包含一些脚本命令，如 build 和 watch。
dependencies：项目的依赖包。
license：项目的许可证。

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，用于配置项目的构建过程。

const path = require('path');

module.exports = {
  entry: './src/js/main.js',
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.scss$/,
        use: ['style-loader', 'css-loader', 'sass-loader']
      }
    ]
  },
  devServer: {
    contentBase: path.join(__dirname, 'dist'),
    compress: true,
    port: 9000
  }
};