Get Started

Before getting started, we strongly recommend that you have a look at a brief description of the system architecture here.

DWKit can be deployed on Windows, Linux and macOS.

It supports databases: MS SQL, PostgreSQL, Oracle.

Three ways for launch DWKit:

1. Starting a DWKit-based project
2. Starting a DWKit-based project with existing DB server
3. I'm a developer, I would like to write a code in IDE

Additional options:

• How to build and run from source codes
• How to update your solution based on DWKit

1. Starting a DWKit-based project (Docker)

1. Install Docker (Docker CE for Windows, Linux instruction).

2. Download the StarterPack or one of the examples from the Download page.

3. Unpack the archive and read readme.txt file.

4. Run the startascontainer script:

   • For Windows: startascontainer.bat

   • For Linux/macOS:

     chmod +x docker-files/wait-for-postgres.sh
     chmod +x startascontainer.sh
     ./startascontainer.sh

     This script build this DWKit's solution and run it with PostgreSQL database.

5. Open the following url in your browser: http://localhost:48800.

   To access the application, use the following default access parameters:

   • Login: admin
   • Password: 1

6. Use http://localhost:48800/admin for access to admin panel.

Next steps

• Admin panel overview
• Data model
• Creating forms
• Setting up workflow
• Using handlers on client-side
• Setting up the security system

2. Starting a DWKit-based project

1. Install .NET 8.0.

2. Set up a database for DWKit or use exist. You need to run scripts from sql folder. Find names of the scripts in sql/<type of DB>/readme.txt file.

3. Check the connection string to the database in the config.cfg file.

   MS SQL Server example:

   ConnectionString=Data Source=(local);Initial Catalog=dwkit;Integrated Security=False;User ID=sa;Password=1

   PostgreSQL example:

   ConnectionString=User ID=postgres;Password=1;Host=localhost;Port=5432;Database=dwkit;

4. Run the starter script:

   • For Windows: start.bat
   • For Linux/macOS:

     chmod +x start.sh
     ./start.sh

5. Open the following url in your browser: http://localhost:48800.

   To access the application, use the following default access parameters:

   • Login: admin
   • Password: 1

6. Use http://localhost:48800/admin for access to admin panel.

Next steps

• Admin panel overview
• Data model
• Creating forms
• Setting up workflow
• Using handlers on client-side
• Setting up the security system

3. How to build and run from source codes

Install .NET 8.0.

• For Windows: run buildandstart.bat

• For Linux/macOS:

  chmod +x buildandstart.sh
  chmod +x start.sh
  ./buildandstart.sh

How to update your solution based on DWKit

1. Run updatesolution script (it requires PowerShell):

• For Windows: run updatesolution_run.bat
• For Linux/macOS:

  pwsh updatesolution.ps1

2. Enter the path to your application.
3. Don't forget update database if it's necessary.
4. Rebuild your solution.