update

fullstackhero · iammukeshm · Jun 15, 2024 · Jun 15, 2024 · Jun 15, 2024 · Jun 15, 2024
commit 792262195f6d37e8693d7a084db1f33244207bbd
diff --git a/src/content/docs/dotnet-starter-kit/general/getting-started.mdx b/src/content/docs/dotnet-starter-kit/general/getting-started.mdx
@@ -1,21 +1,51 @@
 ---
 title: Getting Started 🚀
-description: Let's get started with the FullStackHero .NET Starter Kit! The best way to start a fullstack .NET 8 Web App.
+description: Let's get started with the FullStackHero .NET Starter Kit! The best way to develop a FullStack Multi-Tenant .NET 8 Web App.
 sidebar:
   order: 1
 ---
 
 import { Steps } from '@astrojs/starlight/components';
 
-> Let's get started with the FullStackHero .NET Starter Kit, the best way to start a fullstack .NET 8 Web App.
+> Let's get started with the FullStackHero .NET Starter Kit, the best way to develop a FullStack Multi-Tenant .NET 8 Web App.
 
 The FullStackHero .NET Starter Kit is the ultimate foundation for your next .NET 8 Clean Architecture solution, providing a comprehensive suite of essential packages and features, including built-in Multi-Tenancy support. With its pre-configured setup, this kit can accelerate your project development by saving over 200 hours of implementation time, allowing your team to focus on building core features from day one.
 
 ![FullStackHero .NET Starter Kit](../../../../assets/fullstackhero-dotnet-starter-kit.png)
 
-## Social
+## 🚀 Goals
 
-Follow [@iammukeshm on X](https://x.com/iammukeshm) for project related updates.
+> With Aspire Dashboard, ASP.NET Core Web API & Blazor Client
+
+## ✨ Features & Technologies
+
+- ASP.NET Core 8
+- Entity Framework Core 8
+- Blazor
+- MediatR / CQRS Pattern
+- Specification Pattern
+- Clean Architecture / Verticle Slice Architecture
+- Modular Monolith
+- Multitenancy with Finbuckle
+    - Create Tenants with Multi Database / Shared Database Support
+    - Activate / Deactivate Tenants on Demand
+    - Upgrade Subscription of Tenants - Add More Validity Months to each tenant!
+- PostgreSQL & MSSQL Support Built-In. Can be extended to support any other RDBMS as well
+- API Versioning
+- Minimal API Endpoints
+- Audit Logging to track entity & user history
+- Advanced User & Role Based Permission Management
+- File Storage Service
+- JWT Authentication
+- Logging with Serilog
+- Response Caching - Distributed Caching + REDIS
+- Redis
+- FluentValidation
+- Containerized with Docker
+- Docker-Compose Support
+- One Click Deployment to AWS (ECS/RDS/other networking components) using Terraform
+- CI Pipeline with GitHub Actions
+- Follows Domain Driven Design
 
 ## Prerequisites
 
@@ -33,7 +63,7 @@ For more details, please refer to the [Development Environment Guide](/dotnet-st
 To get started with this starter kit, here are the available options.
 
 1. Install the NuGet .NET CLI Template.
-2. Fork the Repository. Use this if you want to always keep your version of the StarterKit up-to date with the latest changes.
+2. Fork the Repository. (*Use this if you want to always keep your version of the StarterKit up-to date with the latest changes.*)
 
 
 ### FSH .NET CLI Template
@@ -48,51 +78,66 @@ dotnet new install FullStackHero.NET.StarterKit
 
 > To get the latest version of the package, visit [nuget.org](https://www.nuget.org/packages/FullStackHero.NET.StarterKit/). This Starter Kit is now in release candidate stage.
 
+Once the package is installed, you can create a new instance of the project by running,
+
+```
+dotnet new fsh -o Starter
+```
+
+Here, your new solution name would be `Starter`.
+
+This would generate your new solution and also ensures that all the required packages are resolved for you.
+
+![FullStackHero .NET Starter Kit](../../../../assets/docs/general/solution-generation.png)
+
 ### Forking the Repository
 
-Please follow the below instructions.
+You would probably need to take this approach if you want to keep your source code upto date with the latest changes. To get started based on this repository, you need to get a copy locally.
 
-1. Fork this repository to your local.
-2. Open up the `./src/FSH.Starter.sln`.
-3. This would up the FSH Starter solution which has 3 main components.
-   1. Aspire Dashboard (set as the default project)
-   2. Web API
-   3. Blazor
-4. Now we will have to set the connection string for the API. Navigate to `./src/api/server/appsettings.Development.json` and change the `ConnectionString` under `DatabaseOptions`. Save it. Currently the supported database instances are `postgresql` and `mssql`.
-5. Ensure that you have docker desktop up and running. If you want to skip the Docker part, you will have to make the default startup project as the `Server` and `Client` project.
-6. Once that is done, run the application via Visual Studio, with Aspire as the default project. This will open up Aspire Dashboard at `https://localhost:7200/`.
-7. API will be running at `https://localhost:7000/swagger/index.html`.
-8. Blazor will be running at `https://localhost:7100/`.
+- Make a fork of fullstackhero’s dotnet-starter-kit repository in your Github account.
+- Next, since you need to start your private personal project, create your new dotnet-starter-kit personal project by cloning the forked repository on your personal github. This could be done as simple as running `git clone https://github.com/{yourgithubuseraccount}/dotnet-starter-kit.git` locally on your development machine.
+- Setup an upstream remote on your personal project pointing to your forked repository using command `git remote add upstream https://github.com/{yourgithubuseraccount}/dotnet-starter-kit` and `git remote set-url --push upstream DISABLE`
+
+Now, whenever there is a new update on fullstackhero’s dotnet-starter-kit repository, you could simply pull in the latest change on your private fork of the fullstackhero’s dotnet-starter-kit repository and later merge these changes with you personal projects.
 
 ## Your First .NET Starter Kit Solution!
 
 <Steps>
-1. Generate your brand new Solution!
+1. Open up the `./src/FSH.Starter.sln`.
 
-    ```
-    dotnet new fsh -o Starter
-    ```
+2. This would up the FSH Starter solution which has 3 main components.
+
+   1. Aspire Dashboard (set as the default project)
+   2. Web API
+   3. Blazor
 
-    Here, your new solution name would be `Starter`
+3. Now we will have to set the connection string for the API. Navigate to `./src/api/server/appsettings.Development.json` and change the `ConnectionString` under `DatabaseOptions`. Save it. Currently the supported database instances are `postgresql` and `mssql`. By default you can find a PostgreSQL configuration within the `appsettings.Development.json` file. 
+    1. For PostgreSQL,
+        ``` json
+        "DatabaseOptions": {
+            "Provider": "postgresql",
+            "ConnectionString": "Server=192.168.1.110;Database=fullstackherodb;User Id=postgres;Password=password"
+        },
+        ```
+    2. For MSSQL,
 
-2. Here is the solution generation. This also ensures that all the required packages are resolved for you.
+        ``` json
+        "DatabaseOptions": {
+            "Provider": "mssql",
+            "ConnectionString": "Server=192.168.1.104;Database=rootDb;User Id=sa;Password=Password1*;TrustServerCertificate=True;"
+        },
+        ```
 
-    ![FullStackHero .NET Starter Kit](../../../../assets/docs/general/solution-generation.png)
-</Steps>
+4. Ensure that you have docker desktop up and running. If you want to skip the Docker part, you will have to make the default startup project as the `Server` and `Client` project.
 
-## 🚀 Goals
+5. Once that is done, run the application. 
 
-> With Aspire Dashboard, ASP.NET Core Web API & Blazor Client
+6. Aspire Dashboard will be running at `https://localhost:7200/`.
 
-## ✨ Features & Technologies
+7. API will be running at `https://localhost:7000/swagger/index.html`.
 
-- ASP.NET Core 8
-- Entity Framework Core 8
-- Blazor
-- MediatR
-- PostgreSQL
-- Redis
-- FluentValidation
+8. Blazor will be running at `https://localhost:7100/`.
+</Steps>
 
 ## 👨‍🚀 Solution Structure
 
@@ -130,3 +175,5 @@ Please follow the below instructions.
 
 ## ✨ About 
 This starter kit is developed and maintained by [Mukesh Murugan](https://www.linkedin.com/in/iammukeshm/) under [MIT license](https://github.com/fullstackhero/dotnet-starter-kit/blob/main/LICENSE).
+
+Follow [@iammukeshm on X](https://x.com/iammukeshm) for project related updates.