You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A comprehensive SaaS application template built with the [CodeBlock DevKit](https://codeblock.dev/) framework. This template provides a complete foundation for building modern, scalable SaaS applications with enterprise-grade architecture.
3
+
A comprehensive SaaS application template built with the [CodeBlock Dev Kit](https://codeblock.dev). This template provides a complete foundation for building modern, scalable SaaS applications with enterprise-grade architecture.
To use this template, you need to purchase a license from the CodeBlock Dev Kit website. Here's how to get started:
35
34
36
-
### Important Notes
37
-
- All DevKit modules are delivered via NuGet packages, so you only need to maintain your business logic
38
-
- You can update DevKit modules to the latest versions using the update script in the [Build section](#build-and-maintenance)
35
+
1. Visit [codeblock.dev](https://codeblock.dev/#pricing) and purchase a plan.
36
+
2. Go to your [dashboard](https://codeblock.dev/dashboard) and download your license file (`codeblock.dev.license.lic`).
37
+
3. Copy the license file to the root directory of this template project
38
+
4. Execute the setup script to configure your SaaS application
39
39
40
-
## ⚙️ Setup the Template
40
+
41
+
# ⚙️ Setup the Template
41
42
42
43
The template includes automated setup scripts for different operating systems:
43
44
44
-
1.**Navigate to Setup Folder**: Go to the `/setup` directory
45
-
2.**Run Setup Script**: Execute the appropriate script for your OS:
46
-
-**Windows**: Run `setup.bat` or `setup.ps1`
47
-
-**macOS/Linux**: Run `setup.sh`
48
-
3.**Configure Your Application**: The setup wizard will guide you through:
49
-
- Setting your solution name
50
-
- Configuring database settings
51
-
- Setting up admin user credentials
52
-
- Customizing application settings
45
+
1. Go to the `/setup` directory in the template root
46
+
2. Run the appropriate setup script for your OS:
47
+
3. Configure your application via the setup wizard.
53
48
54
-
## 🔧 Build and Maintenance
55
49
56
-
This template includes comprehensive build automation using the [NUKE build system](https://nuke.build/). The build system is organized in the `/4-Build` directory with scripts for different tasks.
50
+
## 🔧 Build, Deploy and Maintenance
57
51
58
-
### Available Build Scripts
52
+
This template includes comprehensive build automation using the [NUKE](https://nuke.build/) build system. You can easily user them in your [CI/CD](.github/workflows) pipelines or run them locally.
59
53
60
-
| Script Category | Location | Purpose |
61
-
|----------------|----------|---------|
62
-
|**Compile**|`/scripts/compile/`| Builds the entire solution |
|`src/4-Build/scripts/tests/`| Executes unit and integration tests |
61
+
|`src/4-Build/scripts/packages/`| Updates CodeBlock Dev Kit NuGet packages |
80
62
81
-
**macOS/Linux:**
82
-
```bash
83
-
# Make scripts executable (one-time setup)
84
-
chmod +x scripts/**/*.sh
85
-
86
-
# Run scripts
87
-
./scripts/compile/Compile.sh
88
-
./scripts/lint/Lint.sh
89
-
./scripts/tests/RunUnitTests.sh
90
-
./scripts/packages/UpdateDevKitPackages.sh
91
-
```
63
+
### Running Build Scripts
92
64
93
65
For detailed information about the build system, see the [Build README](src/4-Build/README.md).
94
66
@@ -107,7 +79,7 @@ The template includes pre-configured CI/CD workflows:
107
79
- For cloud deployment: Update deployment steps for your cloud provider
108
80
- For different platforms: Modify build commands and artifact packaging
109
81
110
-
##🚀 Implement Your Logic and Build Your SaaS
82
+
# 🚀 Implement Your Logic and Build Your SaaS
111
83
112
84
The template includes a complete example implementation to help you understand how to build your own features. Study the demo implementation to learn the patterns:
113
85
@@ -126,7 +98,7 @@ The template includes a complete example implementation to help you understand h
-**Architecture Patterns**: Study the demo implementation to understand clean architecture principles
131
103
-**Best Practices**: Follow the established patterns for consistency and maintainability
132
104
@@ -137,4 +109,4 @@ The template includes a complete example implementation to help you understand h
137
109
3.**Add Your Features**: Implement your business logic following the established patterns
138
110
4.**Deploy**: Use the provided CI/CD workflows or customize them for your deployment environment
139
111
140
-
For detailed guidance on implementing features and customizing the template, refer to the [CodeBlock DevKit Documentation](https://docs.codeblock.dev/).
112
+
For detailed guidance on implementing features and customizing the template, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
0 commit comments