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.
The technology stack of the solution includes:
- .NET Core
- Supported databases: MS SQL, PosgreSQL. Coming soon: AzureSQL, Oracle, MySQL, Redis.
For deployment and further development, you will need the following toolkit:
- .NET Core 2;
- IDE: Visual Studio 2017 or JetBrains Rider;
- webpack 3 only — DWKit will not work with webpack 4;
- Database: MS SQL or PostgreSQL.
Starting a DWKit-based project
- Download the StarterPack or one of the examples from the Download page.
- Unpack the archive.
- Find the scripts for the system deployment in the DB folder. Open the folder that corresponds to your database and run the scripts in the order specified in the readme.txt file. Usually, the order is the following: DWKitScript.sql (main DWKit scripts), Workflow_CreatePersistenceObjects.sql (WorkflowEngine scripts).
- Open the .sln file.
- Check the connection string to the database in the OptimaJet.DWKit.StarterApplication\appsettings.json file, ConnectionStrings section.
- Run the application via the IDE (in case you use Visual Studio, just press F5).
You will see a login form:
To access the application, use the following default access parameters:
- Login: admin
- Password: 1
You will be further redirected to the main page of the application.
The application includes two base projects:
Project OptimaJet.DWKit.Application contains a set of classes for initialization of the platform and support libraries. Find more details in the Initialization section.
Project OptimaJet.DWKit.StarterApplication is an MVC web application, which contains a set of controls and resources for the generation of web interface. Find more details in the Controllers section.
UI based on React
DWKit uses React to create user interfaces. The project includes three .jsx files (located in the OptimaJet.DWKit.StarterApplication\wwwroot\js\app folder):
- app.jsx - application user interface for authorized users;
- login.jsx - login form for unauthorized users;
- admin.jsx - admin panel.
In case you change the JSX files, you will need to reassemble the React part of the application in the following way:
- Install NpmJS and webpack 3 in case you don't have them. DWKit will not work with webpack 4.
- Run a command in the root folder of the project (use the additional -p parameter for release):
npm install webpack --progress
Use the admin panel to adjust the application metadata. To access the admin panel, follow the link:
http://<url>/admin, where url corresponds to the URL of your website.
The admin panel changes the metadata and data in the database via the ConfigAPIController. The metadata are located in the OptimaJet.DWKit.StarterApplication\Metadata folder:
Find more details on the admin panel here.