Repository navigation
Developer Documentation
bjleatherman edited this page Mar 16, 2025
·
1 revision
This document is about how to replicate the development environment for this project.
- 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
- Run the following command to clone it in your local
git clone https://github.com/bjleatherman/BusShuttle
- CD into the solution folder
cd BusShuttleProject- Run the test command
-
dotnet testIf you can see the tests passing, you successfully have the development environment.
- Go inside the project directory
-
cd BusShuttleProjectCD into solution -
cd BusShuttleCD into project dotnet run
-
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
- Inside the solution directory
dotnet publish- Copy/paste
stops.txtfile 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