mirror of
				https://github.com/nonebot/nonebot2.git
				synced 2025-10-31 15:06:42 +00:00 
			
		
		
		
	📝 add creating project
This commit is contained in:
		
							
								
								
									
										55
									
								
								docs/guide/creating-a-project.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								docs/guide/creating-a-project.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,55 @@ | ||||
| # 创建一个完整的项目 | ||||
|  | ||||
| 上一章中我们已经运行了一个最小的 NoneBot 实例,在这一章,我们将从零开始一个完整的项目。 | ||||
|  | ||||
| ## 目录结构 | ||||
|  | ||||
| 首先,我们可以使用 `nb-cli` 或者自行创建项目目录: | ||||
|  | ||||
| ```bash | ||||
| pip install nonebot2[cli] | ||||
| # pip install nb-cli | ||||
| nb create | ||||
| ``` | ||||
|  | ||||
| 这将创建默认的目录结构 | ||||
|  | ||||
| <!-- prettier-ignore-start --> | ||||
| :::vue | ||||
| AweSome-Bot | ||||
| ├── `awesome_bot` _(**或是 src**)_ | ||||
| │   └── `plugins` | ||||
| ├── `.env` | ||||
| ├── `.env.dev` | ||||
| ├── `.env.prod` | ||||
| ├── .gitignore | ||||
| ├── `bot.py` | ||||
| ├── docker-compose.yml | ||||
| ├── Dockerfile | ||||
| ├── `pyproject.toml` | ||||
| └── README.md | ||||
| ::: | ||||
| <!-- prettier-ignore-end --> | ||||
|  | ||||
| - `awesome_bot/plugins` 或 `src/plugins`: 用于存放编写的 bot 插件 | ||||
| - `.env`, `.env.dev`, `.env.prod`: 各环境配置文件 | ||||
| - `bot.py`: bot 入口文件 | ||||
| - `pyproject.toml`: 项目依赖管理文件,默认使用 [poetry](https://python-poetry.org/) | ||||
|  | ||||
| ## 启动 Bot | ||||
|  | ||||
| 如果你使用 `nb-cli` | ||||
|  | ||||
| ```bash | ||||
| nb run [--file=bot.py] [--app=app] | ||||
| ``` | ||||
|  | ||||
| 或者使用 | ||||
|  | ||||
| ```bash | ||||
| python bot.py | ||||
| ``` | ||||
|  | ||||
| :::tip 提示 | ||||
| 如果在 bot 入口文件内定义了 asgi server, `nb-cli` 将会为你启动**冷重载模式** | ||||
| ::: | ||||
| @@ -140,3 +140,5 @@ QQ 协议端举例: | ||||
| ``` | ||||
|  | ||||
| 到这里如果一切 OK,你应该会收到机器人给你回复了 `你好,世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例,开始了编写更强大的 QQ 机器人的创意之旅! | ||||
|  | ||||
| <Messenger :messages="[{ position: 'right', msg: '/say 你好,世界' }, { position: 'left', msg: '你好,世界' }]"/> | ||||
|   | ||||
| @@ -15,7 +15,8 @@ pip install nonebot2 | ||||
| ```bash | ||||
| git clone https://github.com/nonebot/nonebot2.git | ||||
| cd nonebot2 | ||||
| pip install . | ||||
| poetry install --no-dev  # 推荐 | ||||
| pip install .  # 不推荐 | ||||
| ``` | ||||
|  | ||||
| ## 额外依赖 | ||||
|   | ||||
		Reference in New Issue
	
	Block a user