NeuCharFramework(NCF) 是一整套可用于构建基础项目的框架，包含了基础的缓存、数据库、模型、验证及配套管理后台，模块化，具有高度的可扩展性。

当前版本：0.1.0-beta4

说明：NCF 由盛派（Senparc）团队经过多年优化迭代的自用系统底层框架 SenparcCore 整理而来，经历了 .NET 3.5/4.5 众多系统的实战检验，并最终移植到 .NET Core，目前已在多个 .NET Core 系统中稳定运行，在将其转型为开源项目的过程中，需要进行一系列的重构、注释完善和兼容性升级，目前尚处于雏形阶段，希望大家多提意见，我们会争取在最短的时间内优化并发布第一个试用版（Preview1）。感谢大家一直以来的支持！

Preview1 版本中，我们将提供更加完善的模块化架构和辅助工具，当前源码已经可用于学习和测试使用。

当前快速更新分支：Developer

我们欢迎第三方开源组件提供自己的解决方案，我们将会测试并集成到 NCF 中。

NCF 除了会为大家提供完善的框架代码，还会：

1. 提供完善的项目自动生成服务（参考 WeChatSampleBuilder），为开发者提供项目定制生成服务。

2. 提供快捷的模块化开发和安装方法。

3. 提供丰富的应用示例，例如微信、跨平台应用平台对接，等等。

4. 提供完善的示例代码和文档。

5. 提供博客和视频教程（也欢迎开发者参与或发起）。

6. 提供交流社区，包括但不仅限于问答网站、QQ群、微信群、直播群。

• Visual Studio 2019+ 或 VS Code 最新版本

• .NET Core 3.1+ ，SDK下载地址：https://dotnet.microsoft.com/download/dotnet-core/3.1

• 如需查看或修改基础包源代码，请看此项目：https://github.com/NeuCharFramework/NcfPackageSources

安装过程可以选择极客型命令行安装方式，或全自动一键完成。

确保已经安装 SQL Server 2012 及以上版本，系统登录用户具有数据库创建权限（可以不需要使用sa等账号登录），如果必须要使用账号登录，请看这里

这一步是为喜欢体验手敲命令快感的极客准备的，您也可以跳过这一步，直接进入到【第三步】。

1. 同步源代码到本地后，使用 Visual Studio 打开 /src/NCF.sln

2. 在 VS 菜单中选择【工具】>【Nuget包管理器】>【程序包管理器控制台】，打开命令窗口

3. 在【程序包管理器控制台】中的【默认项目】列表中选中 Senparc.Web（默认就是），在 PM> 符号后输入命令：update-database 回车

1. 使用命令行工具或 PowerShell 进入 src/Senparc.Web 路径，例如：E:\NeuCharFramework\NCF\src\Senparc.Web

2. 输入命令：dotnet ef database update 回车

稍等片刻（会自动编译一次项目，因此请勿修改项目代码），完成后输出如下结果，表示数据库安装成功：

Applying migration '20181130085128_init'.
Done.

方法一结果

方法二结果

1. 将 Senparc.Web 项目设为启动项目，并运行，地址如：https://localhost:44311/

未初始化之前，访问首页会自动显示安装界面：

点击【立即安装】按钮：

如果您未手动执行【第二步】，系统将为您在后台自动执行相关步骤。

随后，系统将自动完成初始化安装，此时页面会提示默认管理员账号和密码，请记住这两个参数，以后将无法明文找回！

4. 点击【点击这里登录】，使用已经保存好的管理员账号及密码进行登录：

5. 完成登录

如果登录及管理员后台页面样式缺失，则需要进行这一步，否则可以忽略。

点击查看

NCF 支持“即插即用”的模块化开发模式，您可以面向模块（或领域）进行开发，然后使用 NCF 对模块进行一键集成。

NCF 的扩展模块代号为 XNCF。

找到 XNCF 包并加载 dll 或 从 nuget 安装到 NCF 项目，例如我们官方的一个示例（ChangeNamespace），用于定制修改整个项目的命名空间：https://www.nuget.org/packages/Senparc.Xncf.ChangeNamespace

说明：Senparc.Xncf.ChangeNamespace 模块在 NCF 源码中已默认装载，无需从 nuget 下载。

此时可已经可以看到系统自动扫描到了新增模块：

点击【安装】按钮后，自动进入到模块详情页面，大功告成！

模块默认晚装完毕后，会进入“新增待审核”的状态，点击进行开启即可。

在上一步模块详情页中，列出了当前模块支持的所有功能的列表：

为了让每个模块更加沟通安全，每一个功能都可以预先看到所有参数的透视说明

选择需要执行的方法，点击左侧【执行】按钮。例如点击“修改命名空间”功能的执行【执行】按钮：

按照提示输入对应的参数，点击【运行】按钮，即可执行此模块的此项功能。

执行完成后可以看到提示信息：

程序中所有命名空间已被批量修改：

此过程中无需编写一行代码！

您只需要引用最新的 dll（或安装 nuget 包），系统后台将自动扫描到版本更新：

【模块管理】页面

或 模块详情页面

点击【立即安装】即可完成新版本的升级！

NCF 的扩展模块代号为 XNCF，您可以在 NcfPackageSources 项目中找到我们的模块 示例项目，只需要“依葫芦画瓢”即可。后续稳定版发布之后将有完整的配套文档。

Q：我的系统比较简单，也不需要考虑移植、弹性或扩展，是否可以直接在 NCF 上进行开发？

A：当然可以。加载模块只是为了方便重和系统解耦用而已，NCF 适用于大多数开发场景，包括单体应用、分布式、容器、微信等移动端、跨平台 Hybrid 应用，等等。

• 完善 DDD 实践
• 添加应用商店
• 定制命名空间
• 发布官网及在线 Demo
• 发布定制模板生成器（在线）
  • 可定制默认加载模块