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 MacOSX.
It supports databases: MS SQL, PostgreSQL, Oracle.
Three ways for launch DWKit:
- Starting a DWKit-based project
- Starting a DWKit-based project with existing DB server
- I'm a developer, I would like to write a code in IDE
Additional options:
1. Starting a DWKit-based project (Docker)
-
Install Docker (Docker CE for Windows, Linux instruction)
-
Download the StarterPack or one of the examples from the Download page.
-
Unpack the archive and read readme.txt file.
-
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 Postgres database.
-
Open the following url in your browser: http://localhost:48800
To access the application, use the following default access parameters:
- Login: admin
- Password: 1
- 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
- Install .NET 6.0
- 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.
- 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;
-
Run the starter script
For Windows:
start.bat
For Linux/MacOS:
chmod +x start.sh ./start.sh
-
Open the following url in your browser: http://localhost:48800
To access the application, use the following default access parameters:
- Login: admin
- Password: 1
- 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 6.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
- Run updatesolution script
For Windows:
Run updatesolution_run.bat
For Linux/MacOS:
pwsh updatesolution.ps1
- Enter the path to your application.
- Don't forget update database if it's necessary.
- Rebuild your solution.
It requires PowerShell https://github.com/PowerShell/PowerShell).