dotnet club
----------------------

**Welcome to the dotnet club project. [点此查看中文说明](https://github.com/jijiechen/dotnetclub/blob/dev/Readme.md)。**

This project is source code for a discussion website, it demonstrates how ASP.NET Core can be used to make a user generated web application. The online instance of this project is hosted at [dotnetclub.net](http://dotnetclub.net) which is exactly a real community for discussing .NET Core technical topics.

This project is a web application based on the [.NET Core 2.1](https://www.microsoft.com/net/download/dotnet-core/2.1) open source and cross platform framework. This project will run on [.net core](https://dotnet.github.io/) runtime, but the devlopment tasks still rely on full CLR frameworks(.NET Frmework on Windows and Mono on other systems).

| Branch         | Platform       | Build server | Status                                                                                                                                                                                       |
|----------------|----------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dev            | Linux          | Travis       | [![Travis Status-dev](https://travis-ci.org/jijiechen/dotnetclub.svg?branch=dev)](https://travis-ci.org/jijiechen/dotnetclub/branches)                                                       |
| dev            | Windows        | AppVeyor     | [![AppVeyor Status-dev](https://ci.appveyor.com/api/projects/status/pecgpkageltpj13x/branch/dev?svg=true)](https://ci.appveyor.com/project/jijiechen/dotnetclub/branch/dev)                  |
| master         | Linux          | Travis       | [![Travis Status-master](https://travis-ci.org/jijiechen/dotnetclub.svg?branch=master)](https://travis-ci.org/jijiechen/dotnetclub/branches)                                                 |
| master         | Windows        | AppVeyor     | [![AppVeyor Status-master](https://ci.appveyor.com/api/projects/status/pecgpkageltpj13x/branch/master?svg=true)](https://ci.appveyor.com/project/jijiechen/dotnetclub/branch/master)         |


 

[![codecov](https://codecov.io/gh/jijiechen/dotnetclub/branch/dev/graph/badge.svg)](https://codecov.io/gh/jijiechen/dotnetclub) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

 


### Using the source

This project has following development dependencies:
- .NET Core SDK version 2.1.504
- Node.js version 8.x or above
- Yarn installed

First, clone this repository and compile it to get everything ready:

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

You can work on the source with any text editor or IDE. This project uses the [cakebuild](https://cakebuild.net) as a build tool. Please change the `./build` in sample commands on this page to corresponding cakebuild entrypoint file: 

* Windows: `build.ps1`
* Linux: `build-linux.sh`
* macOS: `build.sh`

To restore packages and compile:

```sh
./build --target=build    # you may need to change the entrypoint file name
```

To execute tests:

```sh
./build --target=test   # you may need to change the entrypoint file name
```

 

### Installation

It's recommended to run this application using [Docker](https://hub.docker.com/r/jijiechen/dotnetclub/tags). You can run the application using this command after docker is installed:

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

You can also compile and run it locally, in that case you'll need .NET Core SDK and node.js tools, and also Mono if you are not working on a Windows PC. After you get a good environment, it's pretty simple to run locally when following these steps:

```sh
git clone https://github.com/jijiechen/dotnetclub.git
cd dotnetclub
./build --target=ci  # you may need to change the entrypoint file name 
cd src/Discussion.Web/publish
dotnet ./Discussion.Web.dll
```

By default, the application will generate a temporary Sqlite database, which will be deleted on process exiting.  If you want to persiste your data, please configure your connection string in configuration files (`appsettings.json`, or `appsettings.<env>.js`)

For more information, please refer to the [wiki documentation](https://github.com/jijiechen/dotnetclub/wiki/%E5%9C%A8%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83%E4%B8%AD%E4%BD%93%E9%AA%8C-Discussion.Web) which currently only available in Chinese.

&nbsp;

### Contributing

Since this project is still under development, so It will be great to have your contribution. 
If you are planning to push back some code, please use the [GitHub Flow](https://help.github.com/articles/github-flow/), when you are going to fix an issue or submit a feature, please create a branch for your work and then file a pull request from that branch.

This project is open source under [the MIT license](LICENSE).

&nbsp;

&nbsp;