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

Environment Requirements

Supported Editors

  • Visual Studio 2022+
  • VS Code Latest Version
  • JetBrains Rider
  • All other editors that support C# compilation

.NET Framework

  • .NET 8, SDK download link: https://dotnet.microsoft.com/en-us/download/dotnet/8.0

    The base library already supports .NET Standard 2.1, compatible with .NET 5 and .NET 6+, NCF templates have been released using .NET 8.

Database

  • NCF supports multiple databases, currently supported are: SQLite, SQL Server, MySQL, PostgreSql, Oracle, DM (Dameng), we will also support more databases, including:
    • Azure Cosmos DB
    • DB2
    • More databases are welcome to tell us: Post

The default database ORM framework is Entity Framework Core (EF Core).

Note:

  1. If using EF Core - SQL Server, you need to use SQL Server 2012 or above version database
  2. We provide two sets of configuration methods for Oracle for V11 and V12+, please choose according to the version you are using.

Operating System

Currently, .NET Core already supports almost all mainstream operating systems:

  • Windows
  • Linux
  • macOS
  • Android
  • iOS/tvOS/MacCatalyst
  • QEMU
  • Other operating systems that support .NET Core: View

Install to server: https://docs.microsoft.com/dotnet/core/install/

CPU Architecture

  • X86
  • x64
  • ARM32
  • ARM64
  • Other CPU architectures that support .NET Core: View

Source Code

  • During the development of NCF, you can use the "NCF Template" project as the base project (100% open source), and run it without modifying any code. Further development can be done on this basis. Source code: https://github.com/NeuCharFramework/NCF
  • Behind the "NCF Template", there is a whole set of base libraries support (also 100% open source). If you need to view, debug, or modify the base package source code, please see this project: https://github.com/NeuCharFramework/NcfPackageSources
Edit this page on GitHub
Last Updated:
Contributors: Jeffrey Su
Prev
About NCF
Next
Frontend and Backend Separation Mode