Riot Todo 项目使用教程
1. 项目的目录结构及介绍
riot-todo/
├── build/
│ └── ...
├── src/
│ ├── editorconfig
│ ├── LICENSE
│ ├── README.md
│ ├── deploy-gh-pages.sh
│ ├── package.json
│ ├── webpack.config.js
│ └── ...
└── ...
- build/: 构建生成的文件目录。
- src/: 源代码目录,包含项目的核心文件。
- editorconfig: 编辑器配置文件。
- LICENSE: 项目许可证文件。
- README.md: 项目说明文档。
- deploy-gh-pages.sh: 部署到 GitHub Pages 的脚本。
- package.json: 项目的依赖和脚本配置文件。
- webpack.config.js: Webpack 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 package.json
中的脚本配置。以下是关键的启动脚本:
{
"scripts": {
"start": "webpack-dev-server --mode development --open",
"build": "webpack --mode production"
}
}
- npm start: 启动开发服务器,自动打开浏览器并访问
http://localhost:8888/
。 - npm run build: 构建生产环境的代码,生成
dist/bundle.js
。
3. 项目的配置文件介绍
package.json
package.json
文件包含了项目的依赖、脚本和其他元数据。以下是关键配置:
{
"name": "riot-todo",
"version": "1.0.0",
"description": "A minimalist didactic application written using the Riot UI library.",
"main": "index.js",
"scripts": {
"start": "webpack-dev-server --mode development --open",
"build": "webpack --mode production"
},
"dependencies": {
"riot": "^5.0.0"
},
"devDependencies": {
"webpack": "^5.0.0",
"webpack-dev-server": "^3.11.0"
}
}
webpack.config.js
webpack.config.js
文件用于配置 Webpack 构建过程。以下是关键配置:
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bundle.js'
},
module: {
rules: [
{
test: /\.riot$/,
exclude: /node_modules/,
use: [{
loader: '@riotjs/webpack-loader',
options: {
hot: true
}
}]
}
]
}
};
- entry: 入口文件路径。
- output: 输出文件路径和名称。
- module: 模块加载规则,配置 Riot 组件的加载器。
通过以上配置,您可以顺利启动和构建 Riot Todo 项目。