Skip to content

Developer Documentation

Daytee92 edited this page Apr 16, 2025 · 5 revisions

This document is about how to replicate the development environment for this project.

SDKs & Tools

Install .NET SDK Version 8 from the official page .NET SDK or install it using your system’s package manager. Install Git from the official page Git GIT or install it using your system’s package manager.

Run the following command to clone the repository in your local git clone https://github.com/Daytee92/CS690-FinalProject

Testing

To test the application, do the following:

  • Go into the solution folder
    • cd TaskManagementSystem
  • Run the test command
    • dotnet test If you can see the tests passing, you successfully have the development environment.

Running

To run the program, do the following:

  • Go inside the project directory
    • cd TaskManagementSystem (solution)
    • cd TaskManagement (into the project)
    • dotnet run

Development

The repository is protected so you can not directly commit to the main branch. Please follow the steps to contribute to the project:

  • Create a branch
  • Perform your changes
  • Test locally to make sure they pass
  • Commit/push your branch
  • Create a pull request

Making a release

  • Inside the solution directory (TaskManagementSystem) run the command
    • dotnet publish
    • run the command zip -r TaskManagementSystem.zip * to create the zip file of the executables

*Create a new release in GitHub with the appropriate version number and notes

Clone this wiki locally