Skip to content

Commit 97b2afe

Browse files
authored
Merge pull request #173 from cloudscribe/version_10.0_claude
Update README.md
2 parents 61c024b + 3bf27cb commit 97b2afe

1 file changed

Lines changed: 69 additions & 22 deletions

File tree

cloudscribeTemplate/README.md

Lines changed: 69 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,49 +2,96 @@
22

33
A project template for rapidly creating new ASP.NET Core web applications using the [cloudscribe](https://www.cloudscribe.com) component libraries.
44

5-
This template includes pre-configured support for:
5+
This template provides a complete foundation with:
66

7-
- ASP.NET Core Identity with cloudscribe enhancements
8-
- Multi-tenancy
9-
- Navigation menus
10-
- Localization
11-
- Bootstrap-based layout and theming
12-
- Modular structure for scalability
7+
- **ASP.NET Core Identity** with cloudscribe multi-tenant enhancements
8+
- **Multi-tenancy** support (folder-based, host-based, or single tenant)
9+
- **SimpleContent CMS** for pages and/or blog functionality
10+
- **Bootstrap 5** theming with 20+ built-in themes
11+
- **Modular architecture** for easy customization and scalability
12+
- **Localization** and internationalization support
13+
- **Dynamic authorization policies** for flexible security
14+
- Optional add-ons: Forms, Paywall, Newsletter, Comments, Forum
1315

1416
## Getting Started
1517

1618
### Prerequisites
1719

18-
- [.NET SDK](https://dotnet.microsoft.com/download) (6.0 or later)
19-
- Visual Studio 2022+ or VS Code
20-
- Optionally: [NuGet CLI](https://www.nuget.org/downloads)
20+
- [.NET 10 SDK](https://dotnet.microsoft.com/download) or later
21+
- Visual Studio 2022+ (or VS Code with C# Dev Kit)
22+
- Database (SQL Server, PostgreSQL, MySQL, SQLite, or NoDb file system)
2123

2224
### Installation via NuGet
2325

24-
You can install the template globally using the .NET CLI:
26+
Install the template globally using the .NET CLI:
2527

26-
```
28+
```bash
2729
dotnet new install cloudscribe.templates
2830
```
2931

3032
### Creating a New Project
3133

32-
After installation, create a new project with:
34+
**Using .NET CLI:**
3335

34-
```
35-
dotnet new cloudscribe --name MyNewApp
36+
```bash
37+
dotnet new cloudscribe --name MyNewApp --DataStorage MSSQL
3638
```
3739

38-
Or use the Visual Studio **New Project** dialog and search for "cloudscribe Project Template".
40+
**Using Visual Studio:**
3941

40-
## Template Options
42+
Use the **New Project** dialog and search for "cloudscribe Project Template".
4143

42-
When creating a project, the template will prompt for:
44+
## Template Options
4345

44-
- **Project Name**: Your application name
45-
- **Database Provider**: SQL Server, PostgreSQL, or SQLite
46-
- **Multi-Tenant Support**: Yes or No
47-
- **UI Theme**: Default Bootstrap or Minimal
46+
### Core Configuration
47+
48+
- **`--DataStorage`** (required): Choose your data storage provider
49+
- `NoDb` - File system storage (no database required)
50+
- `MSSQL` - Microsoft SQL Server (Entity Framework Core)
51+
- `pgsql` - PostgreSQL (Entity Framework Core)
52+
- `MySql` - MySQL (Entity Framework Core) ⚠️ Not yet available for .NET 10
53+
- `SQLite` - SQLite (Entity Framework Core)
54+
- `AllStorage` - Include all providers (for module development)
55+
56+
- **`--MultiTenantMode`**: Multi-tenancy configuration
57+
- `FolderName` (default) - Root tenant + folder-based tenants (`/site1/`, `/site2/`)
58+
- `HostName` - Host-based multi-tenancy (requires DNS configuration)
59+
- `None` - Single tenant installation
60+
61+
- **`--SimpleContentConfig`**: Content management configuration
62+
- `a` (default) - Pages and Blog with Pages as default route
63+
- `b` - Pages and Blog with Home Controller as default route
64+
- `c` - Blog ONLY with Blog as default route
65+
- `d` - Blog ONLY with Home Controller as default route
66+
- `z` - No SimpleContent (excluded)
67+
68+
### Optional Features
69+
70+
- **`--ContactForm`** - Include SimpleContactForm module
71+
- **`--KvpCustomRegistration`** - Include key/value pair custom registration fields
72+
- **`--IdentityServer`** - Include IdentityServer4 integration for OAuth/OpenID Connect
73+
- **`--QueryTool`** - Include admin database query tool (not available with NoDb)
74+
- **`--React`** - Include React/TypeScript integration
75+
- **`--Logging`** - Include cloudscribe logging and log viewer UI (default: true)
76+
- **`--FormBuilder`** - Include Forms and Surveys add-on
77+
- **`--Paywall`** - Include Membership Paywall add-on (not available with NoDb/SQLite)
78+
- **`--Newsletter`** - Include Newsletter/Email List add-on (not available with NoDb/SQLite)
79+
- **`--CommentSystem`** - Include TalkAbout comment system add-on
80+
- **`--Forum`** - Include TalkAbout forum add-on
81+
- **`--DynamicPolicy`** - Include dynamic authorization policies (default: true)
82+
83+
### Example Commands
84+
85+
```bash
86+
# Basic project with SQL Server
87+
dotnet new cloudscribe -n MyApp --DataStorage MSSQL
88+
89+
# Multi-tenant blog with PostgreSQL
90+
dotnet new cloudscribe -n MyBlog --DataStorage pgsql --MultiTenantMode FolderName --SimpleContentConfig c
91+
92+
# Full-featured application with IdentityServer and contact form
93+
dotnet new cloudscribe -n MyPortal --DataStorage MSSQL --IdentityServer true --ContactForm true --DynamicPolicy true
94+
```
4895

4996
## Resources
5097

0 commit comments

Comments
 (0)