Developer Documentation

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 through packages in your linux distro
• Install Git from the official page Git 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/bclapp94/CS690-BusShuttleProject

Testing

• CD into the solution folder
  • cd BusShuttleProject
• 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 BusShuttleProject CD into solution
  • cd ButShuttle CD into 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
  • Copy/paste stops.txt file to the publish folder noted in the output of the command
  • zip -r BusShuttleProject.zip * to create the zip file of the executables
• Create a new release in GitHub with the appropriate version number and notes