Table of Contents

Installation Guide

This guide will walk you through the complete installation process for the CodeBlock DevKit SaaS Template.

Prerequisites

Before installing the template, ensure you have the following dependencies installed on your system:

1. .NET 8 SDK

Purpose: Required to build and run the .NET applications
Version: .NET 8.0+
Download: .NET 8 SDK
Installation: Follow the official installation guide for your operating system
Verification: Run dotnet --version in your terminal to confirm installation

2. MongoDB

Purpose: Primary database for storing application data
Minimum Version: 4.4+
Download: MongoDB Community Server
Connection: Default connection is mongodb://localhost:27017 in all appsettings.json and appsettings.Development.json files
Run as service: The MongoDB server needs to be running as a service on your server or PC

⚠️ Important: For security reasons, do not use the default connection in production and use username/password authentication for your MongoDB connection

3. QdrantDB

Purpose: Vector database for AI chatbot features (optional)
Minimum Version: 1.7+
Download: Qdrant Vector Database
Connection: Default connection is http://localhost:6334 in all appsettings.json files
Note: Only required if your application includes AI chatbot functionality

⚠️ Important: Change default connection in production

Installation Steps

Step 1: Download the Template

You can download this template in two ways:

Option 1: Download ZIP File

  1. Go to the GitHub repository
  2. Click the green < > Code button
  3. Select Download ZIP
  4. Extract the ZIP file to your desired location on your PC

Option 2: Clone with Git

git clone https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template.git
cd CodeBlock.DevKit.SaaS.Template

Step 2: Purchase and Download License

To use this template, you need to purchase a license from the CodeBlock DevKit website:

  1. Visit codeblock.dev and purchase a plan
  2. Go to your dashboard and download your license file (codeblock.dev.license.lic)
  3. Copy the license file to the root directory of this template project

⚠️ Warning: Do not share your license publicly. If your repository is public, add the license to your .gitignore file to prevent it from being uploaded.

Step 3: Run Setup Script

The template includes automated setup scripts for different operating systems:

  1. Go to the /setup directory in the template root
  2. Run the appropriate setup script for your OS:
    • Windows: setup.bat or setup.ps1
    • Linux/macOS: setup.sh
  3. Configure your application via the setup wizard

Step 4: Configure Dependencies

After installation, update connection strings in all client projects (AdminPanel, Api, WebApp) appsettings.json files if you change from defaults:

  • MongoDB: Update connection string if you changed the default port
  • QdrantDB: Update connection string if you changed the default port

Post-Installation Configuration

After setting up and running the template, you need to configure essential services in the admin panel to ensure all pre-built modules work correctly.

Access the Settings Page

  1. Run the AdminPanel project
  2. Navigate to the Settings page in the admin panel
  3. Configure the following three service providers

Required Service Configuration

Email Service Configuration

  • Purpose: Required for user registration, password reset, and notification emails
  • Recommended: Mailgun (suggested for production)
  • Alternatives: SendGrid, Self-hosted email server
  • Setup: Configure email settings with your chosen provider's credentials

SMS Service Configuration

  • Purpose: Required for two-factor authentication and SMS notifications
  • Recommended: Twilio
  • Setup: Add your Twilio Account SID, Auth Token, and phone number

Payment Service Configuration

  • Purpose: Required for subscription management and payment processing
  • Recommended: Stripe
  • Setup:
    1. Create a Stripe account
    2. Configure payment settings with your Stripe API keys (Publishable Key and Secret Key)

⚠️ Important: These services are essential for the template to function properly. Without proper configuration, features like user authentication, notifications, and subscription management will not work correctly.

Verification

To verify your installation:

  1. Build the Solution: Run nuke Compile in the template root or run Compile script from \src\4-Build\scripts\compile path
  2. Run Tests: Execute nuke RunUnitTests to ensure all tests pass or run RunUnitTests script from \src\4-Build\scripts\tests path
  3. Start Applications: Run the AdminPanel, Api, and WebApp projects
  4. Check Demo Features: Navigate to the Demo menu in the admin panel