Pre Requirements

1.Install nuget packages

Right click the Flowfy.HttpApi.Host project and select "Set as StartUp project". Then build the solution. It may take a longer time during the first build since all nuget packages will be restored.

Make sure .NET 8.0 installed and appear in visual studio target framework like below

2.Install npm packages

Navigate to the Flowfy.Web folder and open the terminal, run the following command:

yarn install    

Flowfy.Web is a node.js project, the others one are ASP.Net core projects.

3.Database migration

Flowfy solution includes Flowfy.DbMigrator project, run this console project for database migrations. This project will create your database and tables.

Check the connection strings in the appsettings.json file under the Flowfy.HttpApi.Host and Flowfy.DbMigrator projects.

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

This project will create your database. Initial data will be inserted when you run the Flowfy.DbMigrator project. You can open SQL Server Management Studio to check if database is created:

4.Run API Host (Server side)

First Navigate to the Flowfy.HttpApi.Host folder and open the terminal, run the following command:

npm install

after instaling node modules right click the Flowfy.HttpApi.Host project and Start Without Debugging

After successfully database connection Swagger UI will appear on https://localhost:44316/ as below

5.Run The Application (Client side)

Navigate to theFlowfy.Web project and open the terminal then run the following command:

npm run dev

Open the browser goto http://localhost:44321/ login page will appear as below;

First create new account to login.

Set tenant name 'Flowfy' for superadmin and SaaS management(SaaS menu will apear)


Open the Flowfy.sln project in Visual Studio, build the solution, run the Flowfy.Migration after database configuration, and run the server side Flowfy.HttpApi.Host in debug mode, go to Flowfy.Web project, install the npm packages with yarn install, after successful npm installation, then run the project with npm run dev

Last updated