# NCF
**Repository Path**: NeuCharFramework/NCF
## Basic Information
- **Project Name**: NCF
- **Description**: NeuCharFramework Template Project
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 75
- **Forks**: 66
- **Created**: 2020-08-03
- **Last Updated**: 2025-07-03
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# NCF - NeuCharFramework
NeuCharFramework(NCF) 是一整套可用于构建基础项目的框架，包含了基础的缓存、数据库、模型、验证及配套管理后台，高度模块化，严格遵循 DDD 设计模式，具有高度的可扩展性。
NCF Web 项目模板：[](https://www.nuget.org/packages/Senparc.NCF.Template/)
XNCF 模块模板：[](https://www.nuget.org/packages/Senparc.Xncf.XncfBuilder.Template/)
📚 官方文档：[https://doc.ncf.pub](https://doc.ncf.pub)
💡 在线示例：[https://www.ncf.pub](https://www.ncf.pub)
> **Notice**
> 1. NCF 由盛派（Senparc）团队经过多年优化迭代的自用系统底层框架 SenparcCore 升级而来，经历了 .NET 3.5/4.5 众多系统的实战检验，并最终移植到 .NET Core（同时支持 .NET 6 / .NET 8），目前已在众多系统中稳定运行。感谢大家一直以来的支持！
> 2. 源码中已经附带文档模块，运行 NCF 并安装即可。
> 当前快速更新分支：[Developer](https://github.com/NeuCharFramework/NCF/tree/Developer)
> 已支持数据库：SQLite、MySQL、SQL Server、PostgreSQL、Oracle、DM（达梦），已提供 EFCore 扩展支持，可自行添加更多数据库，只需按照规则添加 1 个文件即可。
> 我们欢迎第三方开源组件提供自己的解决方案，我们将会测试并集成到 NCF 中。
## 在线文档
[https://doc.ncf.pub](https://doc.ncf.pub)
## 当前项目在线 Demo
[https://www.ncf.pub](https://www.ncf.pub)
## QQ 技术交流群
## 环境要求
- Visual Studio 2019+（建议 2022）或 VS Code 最新版本
- [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0)
- 如需查看或修改基础包源代码，请看此项目：https://github.com/NeuCharFramework/NcfPackageSources
> - NCF 默认支持 SQLite、MySQL、SQL Server、PostgreSQL、Oracle、DM（达梦）等数据库，也可自行实现更多数据库类型。
> - 如使用 SQL Server，最低支持版本为 2012
## 如何安装
### 第一步：打开解决方案
下载或同步本项目代码到本地后，打开 `/src/NCF.sln` 解决方案文件，即可看到 NCF 完整的模板项目：
### 第二步：确认 Senparc.Web 为启动项目
`Senparc.Web` 项目是用于启动 Web 站点的项目，确认已经为启动项目（加粗），如果没有，则点击右键，选择【设为启动项目】。
### 第三步：运行
点击顶部菜单【编译】>【开始执行（不调试）】，或快捷键 Ctrl/Command + F5
> 注意：为方便初次运行，默认运行的数据库为 SQLite，如需更换其他数据库，请修改 `Senparc.Web/appsettings.json` 文件中的 `DatabaseType` 值，如 `SqlServer`。
### 完成启动
稍等数秒后，即可完成 NCF Web 项目的启动。
## 首次运行
#### 自动安装
首次运行项目时，系统会对数据库等“基础设施”进行自动安装：
> 注意：默认运行的数据库为 SQL Server，如需更换其他数据库，请查看《使用多数据库》。
点击【立即安装】按钮：
#### 高级选项
> 提示：您也可以点击【高级选项】按钮，对数据库、系统名称、默认管理员登录名等进行自定义：
> 
#### 安装成功
阅读提示并点击确认，随后，即可看到安装成功的界面：
#### 登录后台
登录后即可进入管理员后台：
## 待办事项：
- [x] 定制命名空间
- [x] 提供交流社区，包括但不仅限于[问答网站](https://weixin.senparc.com/QA)、[QQ群](#qq-技术交流群)、微信群、直播群。
- [x] 进一步完善的示例代码和文档。
- [ ] 提供博客和视频教程（也欢迎开发者参与或发起）。
- [ ] 完善 DDD 实践
- [ ] 添加应用商店
- [ ] 提供 CLI 命令行工具
- [ ] 开源 [NeuChar.com](https://www.neuchar.com/) 中的微信功能模块，可使用独立模块集成。
License
--------------
Apache License Version 2.0
```
Copyright 2024 Suzhou Senparc Network Technology Co.,Ltd.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language governing permissions
and limitations under the License.
```
Detail: https://github.com/NeuCharFramework/NcfPackageSources/blob/master/LICENSE
100% 开源，支持商用！