Local Development Guide

[thnaylor]

Local Development:

Setup a local database server:

1. Install SQL Server Management Studio

2. Install SQL Express

3. Once SQL Server Management Studio is installed you should be able to connect to a database server and create new databases.

Setup the local project

There are 2 main folders for the project KhumaloCraft.Web and KhumaloCraft.BusinessAPI.

• KhumaloCraft.Web runs the UI interface
• KhumaloCraft.BusinessAPI runs the Restful interface

Backend server setup

1. Clone the Github repository to your local machine

2. Open the solution with Visual Studio

3. In the KhumaloCraft.BusinessAPI folder:

   • You will see an appsettings.json file. Under connection strings you will see the DefaultConnection. This string provides the connection to the SQL Server database. In most cases it can be left as the default but will need to be changed if connecting to a different database.

4. In the Package Manager Console for KhumaloCraft.BusinessAPI:

   • Run the command Update-Database. If your database server has been installed correctly, the database for the project will automatically be created and you will see the database updated with the Entities used in this project.

5. Start the BusinessAPI server:
   • You should be a Swagger website open up on your localhost with the available endpoints.

Frontend UI setup

1. There is no setup required for the UI besides starting the project. Ensure that the KhumaloCraft.BusinessAPI has been started first as the UI depends on this.

• You can right click on the main solution in the solution explorer -> select properties -> select the projects and order you wish to start.

Both projects should now be running:

Admin logins are set in the SeedData.cs file:

• admin@example.com / AdminPassword123!