MaintDockDocumentation

DocumentationChapter 02 of 14

02What's in the download

Unzip the file that you downloaded from CodeCanyon. You get this content. The app itself is in the maintdock folder.

In the downloadWhat it is
maintdock/binaries/The ready-to-run app. Copy it to your server.
maintdock/source/The full source code (the .NET 10 solution MaintDock.slnx), with the Dockerfile and docker-compose.yml.
maintdock/database/SQL scripts and EF Core migrations.
documentation/This guide. Open documentation/index.html in a browser.
README.txtA short start guide.
CHANGELOG.mdThe list of changes in each version.
THIRD-PARTY-NOTICES.mdThe licenses of the libraries, fonts, and icons.

The binaries folder

This is the published app, built in Release mode. You copy this folder to your server. The main files are:

  • MaintDock.Web.dll: the app. You start it with dotnet MaintDock.Web.dll, or IIS starts it for you.
  • appsettings.json: the settings file. The setup wizard does not change it. The wizard saves the database connection in App_Data/appsettings.json instead.
  • web.config: the settings for IIS on Windows.
  • wwwroot/: styles, scripts, fonts, and icons.
  • Localization/: the translation files. See Translate the app.

When the app runs, it also makes an App_Data folder for uploaded files and security keys.

The source folder

You only need this folder if you want to change the code or build a Docker image. It has the projects in src/, the tests in tests/, small tools in tools/, and the developer guide docs/development.md. See Change the code.

The database folder

This folder has SQL scripts that create the tables (maintdock-sqlserver.sql and maintdock-postgresql.sql), and the EF Core migrations for SQL Server, PostgreSQL, and SQLite. You do not need them. The setup wizard creates the tables for you. The scripts are for database administrators who want to see or check the tables.