Installation

This document is aimed to create and run an Zeroplat based project in just 5 minutes. It’s assumed that you already purchased and created your Zeroplat account.

Pre Requirements

• ​Visual Studio 2017 (for backend ASP.NET Core applications)
• ​.NET Core 9.0​
• ​Node.js 20+ with NPM 6+​
• ​Yarn v1.x​

Backend (ASP.NET Core Application)

1. Open the server-side solution file *.Web.sln in Visual Studio.
2. Right-click the *.Web.Host project and select Set as Startup Project.
3. Build the solution.

• ⚠️ The first build may take longer since NuGet packages will be restored.

Ensure that .NET 9.0 is installed and appears in the Visual Studio target framework options.

Database Setup

Connection String

Update the connection string in appsettings.json under both Zeroplat.HttpApi.Host and Zeroplat.DbMigrator projects.

"ConnectionStrings": {
  "Default": "Server=(LocalDb)\\MSSQLLocalDB;Database=ZeroplatDB;Trusted_Connection=True"
}

"ConnectionStrings": {
  "Default": "Server=(LocalDb)\\MSSQLLocalDB;Database=ZeroplatDB;Trusted_Connection=True"
}

Migrations

There are two ways to apply migrations:

Option 1: Zeroplat Migrator

• Run the Zeroplat.Migrator project included in the solution.
• Use it for both development and production environments.
• See Migrator Documentation for details.

Option 2: Entity Framework Core CLI

1. Open Package Manager Console in Visual Studio.
2. Set Zeroplat.EntityFrameworkCore as the Default Project.
3. Run:

Update-Database

Update-Database

✅ This will create the database. Initial seed data is inserted when you run the *.Web.Host project.
You can verify the database in SQL Server Management Studio.

Run API Host (Server side)

1. Navigate to the Zeroplat.HttpApi.Host folder.
2. Install dependencies:

npm install

npm install

3. In Visual Studio, right-click the Zeroplat.HttpApi.Host project and select Start Without Debugging.

After a successful database connection, Swagger UI will be available at:
👉 https://localhost:44316/

Frontend (React.js Application)

1. Navigate to the Zeroplat.Web folder.
2. Install dependencies:

yarn install

yarn install

3. Start the development server:

npm run dev

npm run dev

Open the browser and go to 👉 http://localhost:44321/

4. The login page will appear.

• Create a new account to log in.
• Use tenant name Zeroplat for SuperAdmin and SaaS Management (SaaS menu will be available).

Summary

1. Open Zeroplat.sln in Visual Studio.
2. Build the solution.
3. Configure the database (using Migrator or EF Core CLI).
4. Start Zeroplat.HttpApi.Host.
5. Navigate to Zeroplat.Web → install dependencies → run npm run dev.
6. Open http://localhost:44321/ in the browser and log in.

🎉 You now have Zeroplat running locally!