NeuCharFramework (NCF)
  • NCF - NeuCharFramework
  • Projects

    • Preparation
    • Basic Library Source Code Analysis
    • DynamicWebApiEngine
    • Deployment
  • Help

    • Online Resources
    • Q&A Community
    • QQ Group (147054579)
    • Senparc WeChat SDK
  • Gitee
  • GitHub
  • English
  • 简体中文
GitHub
  • NCF - NeuCharFramework
  • Projects

    • Preparation
    • Basic Library Source Code Analysis
    • DynamicWebApiEngine
    • Deployment
  • Help

    • Online Resources
    • Q&A Community
    • QQ Group (147054579)
    • Senparc WeChat SDK
  • Gitee
  • GitHub
  • English
  • 简体中文
GitHub
  • NCF Overview

    • NCF - NeuCharFramework
    • About NCF
    • Environment Requirements
    • Frontend and Backend Separation Mode
    • Introduction to Xncf Modules
  • Prepare Development

    • Get NCF Template Source Code
    • Using Visual Studio to Run NCF
    • Running NCF Using CLI
    • Installation
    • Admin Login
    • Admin Backend
    • appsettings.json Configuration
    • Module Management
    • Accessing Documentation
  • Configuration

    • Entry File
    • Database Settings
    • appsettings.json Configuration
    • Docker
    • Dapr
    • Configure Multi-Tenant
    • Redis Cache
  • Modular Development

    • NCF Modular Development Concept
    • Composition of Xncf
    • Create the First Xncf Module
    • Xncf Module Sample Detailed Explanation
    • Implement Your Own Business Logic
    • Update Xncf Module
    • How to Call Between Modules
    • Publish Xncf Module to nuget.org
    • Update Base Library
    • Xncf Module Development
    • Embedding Static Resource Files into NCF
    • Publish Local Nuget Package
    • Advanced
  • Database

    • Database Settings
    • Multi-Database Support
    • Specify Database
    • Update database migration files for the Senparc.Service project (Migrations)
    • Multi-Database Principle
    • DatabasePlant
    • Tarmac Operation Database Migration and Update
  • Unit Testing

    • NCF Unit Test Introduction
    • Start Development
    • Advanced
    • Appendix
  • Q&A

    • NCF Terminology
    • NCF FAQ
  • Release

    • New Features
    • Upgrade Guide
    • Logs

Get NCF Template Source Code

Method 1: Install from Command Line (Recommended)

Open the command line in a development environment where the .NET runtime is installed, and enter:

dotnet new install Senparc.NCF.Template

After successful installation, the client prompts:

Enter the folder where you need to create the project, and enter the command:

dotnet new NCF -n MyProject

Among them, MyProject is the project name, which can be modified as needed. If the -n parameter is not provided, the default name will be used to create.

Method 2: Get Source Code from Source Address

The following two code hosting addresses are the official code release channels for NCF:

  • GitHub: https://github.com/NeuCharFramework/NCF

  • Gitee: https://gitee.com/NeuCharFramework/NCF

💡 Note: The code on Gitee is mirrored from GitHub and may have delays. Therefore, if you want to get the latest version of the code, you can get it from the GitHub site. The operation method is similar.

Below is an example using Gitee, the operation on the GitHub site is similar.

Method 1: Directly Download .zip Package

Open the project source address, click the [Clone/Download] button, and click the [Download ZIP] button to complete the NCF source code download.

After the download is complete, unzip it to the specified address.

Method 2: Use Git to Sync to Local

Open the project source address, click the [Clone/Download] button, and click the [Copy] button to get the git address, such as:

https://gitee.com/NeuCharFramework/NCF.git

Open Visual Studio, click [Clone Repository]:

Paste the git address into [Repository Location], set the [Local Path] for storing the source code, and then click the [Clone] button:

Method 3: Fork First, Then Sync Git (Recommended)

Open the project source address, click the [Fork] button in the upper right corner to make a copy of the official source code under your own account, and then repeat the above "Method 2" under your own copy project:

Note: The Forked repository will not automatically sync the official source code. To get the latest source code, you need to manually sync again.

Edit this page on GitHub
Last Updated:
Contributors: Jeffrey Su
Next
Using Visual Studio to Run NCF