{"id":30580342,"url":"https://github.com/codeblock-dev/codeblock.devkit.saas.template","last_synced_at":"2026-01-03T22:30:14.818Z","repository":{"id":305330027,"uuid":"891149690","full_name":"CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template","owner":"CodeBlock-Dev","description":"SaaS Development Kit for Entrepreneurs","archived":false,"fork":false,"pushed_at":"2025-09-01T21:29:22.000Z","size":2018,"stargazers_count":3,"open_issues_count":21,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-01T23:28:04.910Z","etag":null,"topics":["devkit","saas","saas-template","startup"],"latest_commit_sha":null,"homepage":"https://codeblock.dev","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeBlock-Dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-19T20:17:37.000Z","updated_at":"2025-09-01T21:29:25.000Z","dependencies_parsed_at":"2025-09-01T23:32:14.187Z","dependency_job_id":null,"html_url":"https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template","commit_stats":null,"previous_names":["codeblock-dev/codeblock.devkit.template","codeblock-dev/codeblock.devkit.saas.template"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeBlock-Dev%2FCodeBlock.DevKit.SaaS.Template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeBlock-Dev%2FCodeBlock.DevKit.SaaS.Template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeBlock-Dev%2FCodeBlock.DevKit.SaaS.Template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeBlock-Dev%2FCodeBlock.DevKit.SaaS.Template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeBlock-Dev","download_url":"https://codeload.github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeBlock-Dev%2FCodeBlock.DevKit.SaaS.Template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274887479,"owners_count":25368287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devkit","saas","saas-template","startup"],"created_at":"2025-08-29T05:04:16.699Z","updated_at":"2026-01-03T22:30:14.736Z","avatar_url":"https://github.com/CodeBlock-Dev.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CodeBlock DevKit SaaS Template\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/ci.yml?branch=main\u0026style=flat-square)](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/actions)\n[![Open Issues](https://img.shields.io/github/issues/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template?style=flat-square)](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/issues)\n[![All Issues](https://img.shields.io/github/issues-closed-raw/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template?style=flat-square)](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/issues?q=is%3Aissue)\n[![Latest Release](https://img.shields.io/github/v/release/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template?style=flat-square)](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/releases/latest)\n[![Docs](https://img.shields.io/badge/Docs-Available-blue?style=flat-square)](https://docs.codeblock.dev/)\n\nA comprehensive SaaS application template built with the [CodeBlock DevKit](https://codeblock.dev). This template provides a complete foundation for building modern, scalable SaaS applications with enterprise-grade architecture.\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.youtube.com/embed/s5PO1JIE38w\"\u003e\n    \u003cimg src=\"https://codeblock.dev/images/intro.png\" alt=\"Codeblock DevKit Introduction\" width=\"280\" height=\"157.5\" style=\"border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);\"\u003e\n  \u003c/a\u003e\n\u003cspan\u003e . \u003c/span\u003e\n  \u003ca href=\"https://www.youtube.com/embed/wm54wmv-m4c\"\u003e\n    \u003cimg src=\"https://codeblock.dev/images/saas-template.png\" alt=\"CodeBlock DevKit's SaaS application template\" width=\"280\" height=\"157.5\" style=\"border-radius: 8px; box-shadow: 0 4px 8px rgba(0,0,0,0.1);\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n# 📥 Download the Template\n\nYou can download this template in two ways:\n\n#### Option 1: Download ZIP File\n1. Go to the [GitHub](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template) repository\n2. Click the green `\u003c \u003e Code` button\n3. Select `Download ZIP`\n4. Extract the ZIP file to your desired location on your PC\n\n#### Option 2: Clone with Git\n```bash\ngit clone https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template.git\ncd CodeBlock.DevKit.SaaS.Template\n```\n\n**Note**: All DevKit modules are delivered via [NuGet packages](https://www.nuget.org/profiles/CodeBlock.Dev), so you only need to maintain your own business logic.\n\n# 📋 Purchase a License\n\nTo use this template, you need to purchase a license from theCodeBlock DevKit website. Here's how to get started:\n\n1. Visit [codeblock.dev](https://codeblock.dev/#pricing) and purchase a plan.\n2. Go to your [dashboard](https://codeblock.dev/dashboard) and download your license file (`codeblock.dev.license.lic`).\n3. Copy the license file to the root directory of this template project\n4. Execute the setup script to configure your SaaS application\n\n- **⚠️ 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.\n\n# ⚙️ Setup the Template\n\nThe template includes automated setup scripts for different operating systems:\n\n1. Go to the `/setup` directory in the template root\n2. Run the appropriate setup script for your OS:\n3. Configure your application via the setup wizard.\n\n# 🗄️ Prerequisite Dependencies\n\nThis template requires three dependencies to run:\n\n#### .NET 8 SDK\n- **Purpose**: Required to build and run the .NET applications\n- **Version**: .NET 8.0+\n- **Download**: [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)\n- **Installation**: Follow the official installation guide for your operating system\n- **Verification**: Run `dotnet --version` in your terminal to confirm installation\n\n#### MongoDB\n\n#### MongoDB\n- **Purpose**: Primary database for storing application data\n- **Minimum Version**: 4.4+\n- **Download**: [MongoDB Community Server](https://www.mongodb.com/try/download/community)\n- **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.\n- **Run as service**: The MongoDB server needs to be running as a service on your server or PC.\n- **⚠️ Important**: For security reasons, do not use the default connection in production and use username/password authentication for your MongoDB connection\n\n#### QdrantDB\n- **Purpose**: Vector database for AI chatbot features (optional)\n- **Minimum Version**: 1.7+\n- **Download**: [Qdrant Vector Database](https://qdrant.tech/documentation/guides/installation/)\n- **Connection**: Default connection is `http://localhost:6334` in all `appsettings.json` files\n- **⚠️ Important**: Change default connection in production\n- **Note**: Only required if your application includes AI chatbot functionality\n\n**Configuration**: After installation, update connection strings in all client projects (`AdminPanel`, `Api`, `WebApp`) `appsettings.json` files if you change from defaults.\n\n# 🚀 Implement Your Logic and Build Your SaaS\n\nThe template includes a complete example implementation called 'DemocThings' to help you understand how to build your own features.\n- Run the `src/2-Clients/Api` project and see `DemocThings` APIs.\n- Run the `src/2-Clients/AdminPanel` project and navigate to `Demo` menu item.\n- Look at the code in the `src/1-Libraries/Application/Services/DemoThings` to see how the application services are structured.\n- Look at `src/1-Libraries/Application/UseCases/DemoThings/` to see how the use cases are implemented.\n- Look at the `src/1-Libraries/Core/Domain/DemoThings/` to see how the domain logic is structured.\n- Look at the `src/3-Tests/Application.Tests.Unit/UseCases/DemoThings/` to see how unit tests are written.\n- Look at the `src/3-Tests/Application.Tests.Integration/UseCases/DemoThings/` to see how integration tests are structured.\n\nFor detailed guidance on implementing features and customizing the template, refer to the [CodeBlock DevKit Documentation](https://docs.codeblock.dev/).\n\n**💡 AI Coding Tip**: When using AI coding agents (like GitHub Copilot, Cursor), you can reference the `DemoThings` sample implementation to help the AI understand your project's architecture and coding patterns. This sample serves as a great example for the AI model to follow when implementing similar features in your SaaS application.\n\n# 🔧 Build, Deploy and Maintenance\n\nThis 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`.\n\n#### Local Build Scripts\n\nFor convenience, we've provided scripts to run build tasks locally:\n\n| Script Location | Purpose |\n|----------------|----------|\n| `src/4-Build/scripts/compile/` | Builds the entire solution |\n| `src/4-Build/scripts/lint/` | Runs code quality checks |\n| `src/4-Build/scripts/tests/` | Executes unit and integration tests |\n| `src/4-Build/scripts/packages/` | UpdatesCodeBlock DevKit NuGet packages |\n\nFor detailed build system documentation, see the [Build README](src/4-Build/README.md).\n\n#### CI/CD Configuration\n\n- **CI Workflow** (`.github/workflows/ci.yml`): Pre-configured to build, test, and package your application\n- **CD Workflow** (`.github/workflows/cd.yml`): Configured for Windows IIS deployment\n\nYou 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.\n\nFor detailed CI/CD guidance, refer to the [CodeBlock DevKit Documentation](https://docs.codeblock.dev/).\n\n# ⚙️ Configure Required Services\n\nAfter setting up and running the template, you need to configure essential services in the admin panel to ensure all pre-built modules work correctly and provide a complete user experience.\n\n#### Access the Settings Page\n1. Run the `AdminPanel` project\n2. Navigate to the **Settings** page in the admin panel\n3. Configure the following three service providers:\n\n#### Email Service Configuration\n- **Purpose**: Required for user registration, password reset, and notification emails\n- **Recommended**: [Mailgun](https://www.mailgun.com/) (suggested for production)\n- **Alternatives**: \n  - [SendGrid](https://sendgrid.com/)\n  - Self-hosted email server\n- **Setup**: Configure email settings with your chosen provider's credentials\n\n#### SMS Service Configuration\n- **Purpose**: Required for two-factor authentication and SMS notifications\n- **Recommended**: [Twilio](https://www.twilio.com/)\n- **Setup**: Add your Twilio Account SID, Auth Token, and phone number\n\n#### Payment Service Configuration\n- **Purpose**: Required for subscription management and payment processing\n- **Recommended**: [Stripe](https://stripe.com/)\n- **Setup**: \n  1. Create a [Stripe account](https://dashboard.stripe.com/register)\n  2. Configure payment settings with your Stripe API keys (Publishable Key and Secret Key)\n\n**⚠️ 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.\n\n# 🛟 Support \u0026 Feedback\n\nIf 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.\n\n1. Visit [GitHub Issues](https://github.com/CodeBlock-Dev/CodeBlock.DevKit.SaaS.Template/issues)\n2. Click the green \"New issue\" button\n3. Input a title and explain the issue\n4. Submit your request\n\nSoon, we will provide a Discord server for easier communication and community support. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeblock-dev%2Fcodeblock.devkit.saas.template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeblock-dev%2Fcodeblock.devkit.saas.template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeblock-dev%2Fcodeblock.devkit.saas.template/lists"}