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
Copy file name to clipboardExpand all lines: README.md
+31-28Lines changed: 31 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,33 +48,6 @@ The template includes automated setup scripts for different operating systems:
48
48
2. Run the appropriate setup script for your OS:
49
49
3. Configure your application via the setup wizard.
50
50
51
-
52
-
## 🔧 Build, Deploy and Maintenance
53
-
54
-
This template includes comprehensive build automation that covers compilation, linting, and testing. The build system is already integrated into the CI workflow at `.github/workflows/ci.yml`.
55
-
56
-
#### Local Build Scripts
57
-
58
-
For convenience, we've provided scripts to run build tasks locally:
59
-
60
-
| Script Location | Purpose |
61
-
|----------------|----------|
62
-
|`src/4-Build/scripts/compile/`| Builds the entire solution |
|`src/4-Build/scripts/tests/`| Executes unit and integration tests |
65
-
|`src/4-Build/scripts/packages/`| Updates CodeBlock Dev Kit NuGet packages |
66
-
67
-
For detailed build system documentation, see the [Build README](src/4-Build/README.md).
68
-
69
-
#### CI/CD Configuration
70
-
71
-
-**CI Workflow** (`.github/workflows/ci.yml`): Pre-configured to build, test, and package your application
72
-
-**CD Workflow** (`.github/workflows/cd.yml`): Configured for Windows IIS deployment
73
-
74
-
You can modify these workflows based on your deployment environment. The template is not limited to any specific platform - you can deploy to cloud services, Linux servers, Windows servers, or any other environment of your choice.
75
-
76
-
For detailed CI/CD guidance, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
77
-
78
51
# 🗄️ Prerequisite Dependencies
79
52
80
53
This template requires two dependencies to run:
@@ -83,14 +56,18 @@ This template requires two dependencies to run:
83
56
-**Purpose**: Primary database for storing application data
84
57
-**Minimum Version**: 4.4+
85
58
-**Download**: [MongoDB Community Server](https://www.mongodb.com/try/download/community)
59
+
-**Connection**: Default connection is `mongodb://localhost:27017` in all `appsettings.json` and `appsettings.Development.json` files. If you change the default port while installing MongoDB server, remember to update the connection in appsettings files as well.
60
+
-**⚠️ Important**: For security reasons, do not use the default connection in production and use username/password authentication for your MongoDB connection
86
61
87
62
#### QdrantDB
88
63
-**Purpose**: Vector database for AI chatbot features (optional)
-**Connection**: Default connection is `http://localhost:6334` in all `appsettings.json` files
67
+
-**⚠️ Important**: Change default connection in production
91
68
-**Note**: Only required if your application includes AI chatbot functionality
92
69
93
-
Install these dependencies in your deployment environment before running the template.
70
+
**Configuration**: After installation, update connection strings in all client projects (`AdminPanel`, `Api`, `WebApp`) `appsettings.json` files if you change from defaults.
94
71
95
72
# 🚀 Implement Your Logic and Build Your SaaS
96
73
@@ -105,6 +82,32 @@ The template includes a complete example implementation to help you understand h
105
82
106
83
For detailed guidance on implementing features and customizing the template, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
107
84
85
+
# 🔧 Build, Deploy and Maintenance
86
+
87
+
This template includes comprehensive build automation that covers compilation, linting, and testing. The build system is already integrated into the CI workflow at `.github/workflows/ci.yml`.
88
+
89
+
#### Local Build Scripts
90
+
91
+
For convenience, we've provided scripts to run build tasks locally:
92
+
93
+
| Script Location | Purpose |
94
+
|----------------|----------|
95
+
|`src/4-Build/scripts/compile/`| Builds the entire solution |
|`src/4-Build/scripts/tests/`| Executes unit and integration tests |
98
+
|`src/4-Build/scripts/packages/`| Updates CodeBlock Dev Kit NuGet packages |
99
+
100
+
For detailed build system documentation, see the [Build README](src/4-Build/README.md).
101
+
102
+
#### CI/CD Configuration
103
+
104
+
-**CI Workflow** (`.github/workflows/ci.yml`): Pre-configured to build, test, and package your application
105
+
-**CD Workflow** (`.github/workflows/cd.yml`): Configured for Windows IIS deployment
106
+
107
+
You can modify these workflows based on your deployment environment. The template is not limited to any specific platform - you can deploy to cloud services, Linux servers, Windows servers, or any other environment of your choice.
108
+
109
+
For detailed CI/CD guidance, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
110
+
108
111
# 🛟 Support & Feedback
109
112
110
113
If you need help, have a question, or want to report a bug, you can create an issue and we will respond as soon as possible.
0 commit comments