Skip to content

Commit 7c4a85d

Browse files
chore: update Prerequisite Dependencies section
1 parent 8799037 commit 7c4a85d

File tree

1 file changed

+31
-28
lines changed

1 file changed

+31
-28
lines changed

README.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -48,33 +48,6 @@ The template includes automated setup scripts for different operating systems:
4848
2. Run the appropriate setup script for your OS:
4949
3. Configure your application via the setup wizard.
5050

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 |
63-
| `src/4-Build/scripts/lint/` | Runs code quality checks |
64-
| `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-
7851
# 🗄️ Prerequisite Dependencies
7952

8053
This template requires two dependencies to run:
@@ -83,14 +56,18 @@ This template requires two dependencies to run:
8356
- **Purpose**: Primary database for storing application data
8457
- **Minimum Version**: 4.4+
8558
- **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
8661

8762
#### QdrantDB
8863
- **Purpose**: Vector database for AI chatbot features (optional)
8964
- **Minimum Version**: 1.7+
9065
- **Download**: [Qdrant Vector Database](https://qdrant.tech/documentation/guides/installation/)
66+
- **Connection**: Default connection is `http://localhost:6334` in all `appsettings.json` files
67+
- **⚠️ Important**: Change default connection in production
9168
- **Note**: Only required if your application includes AI chatbot functionality
9269

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.
9471

9572
# 🚀 Implement Your Logic and Build Your SaaS
9673

@@ -105,6 +82,32 @@ The template includes a complete example implementation to help you understand h
10582

10683
For detailed guidance on implementing features and customizing the template, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
10784

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 |
96+
| `src/4-Build/scripts/lint/` | Runs code quality checks |
97+
| `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+
108111
# 🛟 Support & Feedback
109112

110113
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

Comments
 (0)