Skip to content

Latest commit

 

History

History
95 lines (58 loc) · 5.15 KB

Readme.md

File metadata and controls

95 lines (58 loc) · 5.15 KB
Raw

dotnet club

欢迎关注 dotnet club 项目。 Click here to see English readme.

本项目是一个论坛网站的源码，完整地展示了如何用 ASP.NET Core 技术开发一个用户参与的 Web 应用。您可以在 dotnetclub.net 直接访问本项目的在线实例，并且在该网站上参与 .NET Core 相关技术的讨论。

本项目是一个 Web 应用程序，基于开源和跨平台的 .NET Core 2.1 运行时。如果你打算研究或者参与贡献，您仍需要完整的 .NET Framework 或者 Mono 运行时来运行相关的开发任务。

分支 平台 集成服务 当前状态
dev Linux Travis Travis Status-dev
dev Windows AppVeyor AppVeyor Status-dev
master Linux Travis Travis Status-master
master Windows AppVeyor AppVeyor Status-master

 

codecov License: MIT

 

使用源代码

在开发环境中，项目有下列依赖项：

  • .NET Core 2.1 SDK （版本 2.1.504）
  • Node.js 版本 v8.x 以上
  • 安装 Yarn

首先，克隆当前仓库，并完成编译一次，就可以将所需要的环境准备好：

git clone https://github.com/jijiechen/dotnetclub.git
cd dotnetclub

本项目使用了 cakebuild 作为构建工具。在执行下面描述的构建命令时，请将 ./build 换成您自己所在平台对应的文件：

  • Windows: build.ps1
  • Linux: build-linux.sh
  • macOS: build.sh

可以使用下面的命令，来还源、安装所有依赖的包，并编译项目：

./build --target=build   # 可能需要修改入口文件的名字

可以使用下面的命令，来运行单元测试：

./build --target=test     # 可能需要修改入口文件的名字

 

安装

如果只是要运行本项目，您可以直接使用 Docker 来安装。下面的命令可以帮助您在本地运行一个示例：

docker run -d --name club -p 5000:5000 jijiechen/dotnetclub:201905061027

您也可以直接在本地编译并运行，但您需要在本地安装 .NET Core SDK、node.js （如果是在非 Windows 电脑上，还需要 Mono）等一系列依赖才能编译。环境准备就绪后，实际的编译过程很简单：

git clone https://github.com/jijiechen/dotnetclub.git
cd dotnetclub
./build --target=ci      # 可能需要修改入口文件的名字
cd src/Discussion.Web/publish
dotnet ./Discussion.Web.dll

默认情况下，应用程序会自动创建一个 Sqlite 数据库用于存储，这个数据库会在进程退出时失效。因此，如果你需要留存这些数据话，请修改 appsettings.json 或者 appsettings.<环境>.json 配置文件来配置数据库位置。

详细情况，请参考项目的 Wiki 文档。

 

贡献代码

当前项目还处于活跃的开发之中，非常欢迎您参与贡献。如果您打算提交代码，请提前在 Projects 页面上了解最新开发计划，并按照 GitHub Flow 的流程，使用 Pull Request 的方式提交代码。简单来说，就是在编写功能或者修复问题时，先创建一个对应的分支，然后再从那个分支提交 Pull Request。

本项目采用 MIT 开源协议 开源。