dnnsoftware / Dnn.Platform

DNN (formerly DotNetNuke) is the leading open source web content management platform (CMS) in the Microsoft ecosystem.
https://dnncommunity.org/
MIT License
1.01k stars 745 forks source link

[Enhancement]: Add a DNN_Platform.local-sample.build to make setup easier #6060

Open iJungleboy opened 1 month ago

iJungleboy commented 1 month ago

Is there an existing issue for this?

Description of problem

It's really hard to get started building DNN. Especially the step with the build-target local is really hard to figure out.

Description of solution

Create a sample file called DNN_Platform.local-sample.build containing a template and instructions.

This would be the contents

<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <!-- 
    *** Background ***
    This file is a sample for your own "DNN_Platform.local.build" file.
    Read about it in the readme: https://github.com/dnnsoftware/Dnn.Platform/blob/develop/.github/BUILD.md

    *** Instructions ***
    1. Copy this file in this folder, but rename the copy to "DNN_Platform.local.build".
    2. Customize the target path below to match your local environment.
  -->
  <PropertyGroup>
    <WebsitePath Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">C:\Projects\dnn\dnn-09\Website</WebsitePath>
  </PropertyGroup>
</Project>

Description of alternatives considered

No response

Anything else?

No response

Do you be plan to contribute code for this enhancement?

Would you be interested in sponsoring this enhancement?

Code of Conduct

valadas commented 1 month ago

Sounds good to me. I wanted to make some sort of wizard on the build scripts to guide people through steps according to what they plan to do, but never found the time to do so.