Skip to content

Commit aca833d

Browse files
chore: update readme
1 parent dad2143 commit aca833d

1 file changed

Lines changed: 44 additions & 72 deletions

File tree

README.md

Lines changed: 44 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,66 @@
1-
# CodeBlock DevKit Template
1+
# CodeBlock Dev Kit Template
22

3-
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.
44

5-
## 🎬 Demo & Resources
5+
<div align="center">
6+
<a href="https://www.youtube.com/embed/dQw4w9WgXcQ" target="_blank">
7+
<img src="https://img.youtube.com/vi/dQw4w9WgXcQ/maxresdefault.jpg" alt="CodeBlock Dev Kit Template Demo" width="560" height="315" style="border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);">
8+
</a>
9+
</div>
610

7-
- **Website**: [https://codeblock.dev/](https://codeblock.dev/)
8-
- **Documentation**: [https://docs.codeblock.dev/](https://docs.codeblock.dev/)
9-
- **Demo Video**: [Watch how to use this template](https://codeblock.dev/demo)
11+
# 📥 Download the Template
1012

11-
## 📋 Prerequisites: Purchasing a License
13+
You can download this template in two ways:
1214

13-
To use this template, you need to purchase a license from the CodeBlock DevKit website. Here's how to get started:
15+
#### Option 1: Download ZIP File
16+
1. Go to the [GitHub](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.Template) repository
17+
2. Click the green `< > Code` button
18+
3. Select `Download ZIP`
19+
4. Extract the ZIP file to your desired location on your PC
1420

15-
1. **Purchase a License**: Visit [https://codeblock.dev/pricing](https://codeblock.dev/pricing) and select the appropriate license for your needs
16-
2. **Download Your License**: After purchase, download your license file from your user dashboard
17-
3. **Place License File**: Copy the license file to the root directory of this template project
18-
4. **Run the Template**: Execute the setup script to configure your SaaS application
21+
#### Option 2: Clone with Git
22+
```bash
23+
git clone https://github.com/CodeBlock-Dev/CodeBlock.Dev Kit.Template.git
24+
cd CodeBlock.Dev Kit.Template
25+
```
1926

20-
## 📥 Download the Template
27+
**Note**: All Dev Kit modules are delivered via NuGet packages, so you only need to maintain your own business logic.
2128

22-
You can download this template in two ways:
2329

24-
### Option 1: Download ZIP File
25-
1. Go to [https://github.com/CodeBlock-Dev/CodeBlock.DevKit.Template](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.Template)
26-
2. Click the green "Code" button
27-
3. Select "Download ZIP"
28-
4. Extract the ZIP file to your desired location
30+
-
31+
# 📋 Purchase a License
2932

30-
### Option 2: Clone with Git
31-
```bash
32-
git clone https://github.com/CodeBlock-Dev/CodeBlock.DevKit.Template.git
33-
cd CodeBlock.DevKit.Template
34-
```
33+
To use this template, you need to purchase a license from the CodeBlock Dev Kit website. Here's how to get started:
3534

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
3939

40-
## ⚙️ Setup the Template
40+
41+
# ⚙️ Setup the Template
4142

4243
The template includes automated setup scripts for different operating systems:
4344

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

54-
## 🔧 Build and Maintenance
5549

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
5751

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

60-
| Script Category | Location | Purpose |
61-
|----------------|----------|---------|
62-
| **Compile** | `/scripts/compile/` | Builds the entire solution |
63-
| **Lint** | `/scripts/lint/` | Runs code quality checks |
64-
| **Tests** | `/scripts/tests/` | Executes unit and integration tests |
65-
| **Packages** | `/scripts/packages/` | Updates CodeBlock.DevKit NuGet packages |
6654

67-
### Running Build Scripts
68-
69-
**Windows:**
70-
```powershell
71-
# PowerShell (recommended)
72-
.\scripts\compile\Compile.ps1
73-
.\scripts\lint\Lint.ps1
74-
.\scripts\tests\RunUnitTests.ps1
75-
.\scripts\packages\UpdateDevKitPackages.ps1
7655

77-
# Or batch files
78-
scripts\compile\Compile.bat
79-
```
56+
| Location | Purpose |
57+
|----------------|----------|---------|
58+
| `src/4-Build/scripts/compile/` | Builds the entire solution |
59+
| `src/4-Build/scripts/lint/` | Runs code quality checks |
60+
| `src/4-Build/scripts/tests/` | Executes unit and integration tests |
61+
| `src/4-Build/scripts/packages/` | Updates CodeBlock Dev Kit NuGet packages |
8062

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
9264

9365
For detailed information about the build system, see the [Build README](src/4-Build/README.md).
9466

@@ -107,7 +79,7 @@ The template includes pre-configured CI/CD workflows:
10779
- For cloud deployment: Update deployment steps for your cloud provider
10880
- For different platforms: Modify build commands and artifact packaging
10981

110-
## 🚀 Implement Your Logic and Build Your SaaS
82+
# 🚀 Implement Your Logic and Build Your SaaS
11183

11284
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:
11385

@@ -126,7 +98,7 @@ The template includes a complete example implementation to help you understand h
12698
- **Integration Tests**: `/src/3-Tests/Application.Tests.Integration/UseCases/DemoThings/`
12799

128100
### Learning Resources
129-
- **DevKit Documentation**: [https://docs.codeblock.dev/](https://docs.codeblock.dev/)
101+
- **Dev Kit Documentation**: [https://docs.codeblock.dev/](https://docs.codeblock.dev/)
130102
- **Architecture Patterns**: Study the demo implementation to understand clean architecture principles
131103
- **Best Practices**: Follow the established patterns for consistency and maintainability
132104

@@ -137,4 +109,4 @@ The template includes a complete example implementation to help you understand h
137109
3. **Add Your Features**: Implement your business logic following the established patterns
138110
4. **Deploy**: Use the provided CI/CD workflows or customize them for your deployment environment
139111

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

Comments
 (0)