kcm-web.Admin 1.0.0

XK Custom Admin UI

Manage and update a custom UI for Xperience by Kentico Projects.

Adding Nuget Package

1. Sign in or create account at https://www.nuget.org/

2. Copy the API Key to upload your nuget package into the account.

3. Define Nuget Package metadata in the .csproj file

   <Project Sdk="Microsoft.NET.Sdk">
       ...
   
   
       <PropertyGroup>
           <PackageId>webdev1kev.Admin</PackageId>
           <Version>1.0.1</Version>
           <SymbolPackageFormat>snupkg</SymbolPackageFormat>
           <RepositoryUrl></RepositoryUrl>
           <PackageProjectUrl></PackageProjectUrl>
           <PackageTags>KCM XK asp admin</PackageTags>
           <Description>
           Add custom XK Admin UI to any XK Project
           </Description>
           <PackageReadmeFile>README.md</PackageReadmeFile>
       </PropertyGroup>
   
       <ItemGroup>
           <None Include="README.md" Pack="true" PackagePath="\"/>
       </ItemGroup>
   
   ...
   

</Project>

4. Package up your project with the following command:

    ``
      dotnet pack --configuration Release 
    ``
5. Locate the generated `.nupkg` file and add the following command to upload to nuget:

    ``
        dotnet nuget push ./bin/Release/<package-name>.nupkg --api-key <your-api-key> --source https://api.nuget.org/v3/index.json
    ``
    
    **Note: The beginning of your package name should be the Owner or Account username to avoid errors on upload.**

## Updating Nuget Package

1.  Update your version number:

    ```
    <Project Sdk="Microsoft.NET.Sdk">
        ...

        
        <PropertyGroup>
            <PackageId>kcm-web.Admin</PackageId>
            
            <Version>1.0.1</Version>
            <SymbolPackageFormat>snupkg</SymbolPackageFormat>
            <RepositoryUrl></RepositoryUrl>
            <PackageProjectUrl></PackageProjectUrl>
            <PackageTags>KCM XK asp admin</PackageTags>
            <Description>
            Add custom XK Admin UI to any XK Project
            </Description>
            <PackageReadmeFile>README.md</PackageReadmeFile>
        </PropertyGroup>

        <ItemGroup>
            <None Include="README.md" Pack="true" PackagePath="\"/>
        </ItemGroup>
    
        ...
    </Project>
    ```

2. Package up your project with the following command:

    ``
      dotnet pack --configuration Release 
    ``

3. Find your latest `.nupkg` in the Release folder and upload with the `nuget push` command

    ``
        dotnet nuget push ./bin/Release/<package-name>.nupkg --api-key <your-api-key> --source https://api.nuget.org/v3/index.json
    ``

## Development

**[XK Admin Environment Reference](https://docs.kentico.com/developers-and-admins/customization/extend-the-administration-interface/prepare-your-environment-for-admin-development)**

Xperience Admin UI needs an Xperience Project running to connect and see the interface being developed.

You can download a sample project at ...

1. With a sample project installed start the project locally using the development configuration for appsettings.

2. Navigate to the Client folder in the XK-Admin project on your terminal and run `npm i` and `npm run start` to start the Admin UI server.

You now have a running version of the Custom Admin UI running on your local project and changes to the UI will be automatically updated.

See: [Extend the administration interface](https://docs.kentico.com/developers-and-admins/customization/extend-the-administration-interface) to learn more about customizing the Admin UI