Developer Documentation - LittleBo22/-CS690-finalproject GitHub Wiki

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

SDKs and Tools

• Initial .NET SDK version 8 from the official page .NET SDK or through packages in your linux distro
• Install Git from the official page Git or through packages in your linux distro.

Clone the repository in your local

• Run the following command to clone it in your local
  • git clone https://github.com/LittleBo22/-CS690-finalproject

Testing

• CD into the solution folder
  • cd CalendarProject
• Run the test command
  • dotnet test (if you can see the tests passing, you successfully have the development environment)

Running

• Go Inside the project directory
  • cd CalendarProject (CD into solution)
  • cd Calendar (CD 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
• Do your changes
• Test locally and make sure they pass
• Commit/Push your branch
• Create a pull request

Making a release

• Inside the solution directory
  • dotnet publish
  • zip -r CalendarProject.zip * to create the zip file of the executables
• Create a new release in Github with the appropriate version number and notes