README.md

Minor project : OptimalDelivery

This software is a route planning system and the purpose of this product is to provide the user with the most optimal and cost efficient route to the trucks between the pick-up point which is predetermined and the consumer. Team 4 decided to use a command line interface by using the front end language, python. To approach this prompt, the team used agile methodology and scrum calls to address and come up with a solution in four sprints that involved: Requirements engineering; System Modeling; Architectural Design; Design and Implementation; Software Testing; and Evaluation. All of these components helped us come up with a program that satisfies all the requirements.

Rutgers Delivery Tool

Basic Setup

1. Install Poetry. Don't forget to add the poetry command to your PATH (Instructions to do this is given post-installation)
2. Navigate to the GitHub Project
3. Install Dependencies with poetry install
4. Run with poetry run python3 rutgersdelivery/main.py. You need Python 3.9 and above to run

Password is rurahrah

How to run the program

This is on how to input user values:

1. Click on the rutgersdelivery folder and open up the main.py file.
2. Run this program.
3. It asks for user input:
   • Password: 'rurahrah'
   • If password is verified, it asks for the number of trucks required.
   • Enter the number of trucks available
   • Enter the number of routes required
   • If approved (# of trucks >= # of routes) , the gas price is displayed
   • The next input is points of the truck's route
   • The input would be added to the truck's current route list
   • If finished, select 'END ROUTE SELECTION' option
   • If not finished, more inputs can be added
   • The application outputs Gas price, Optimal distance and Optimal Route

How to run test cases

We ran the testcases using pytest.

1. Navigate to the 'tests' section of the code
2. Embedded in this section you need to go to the 'test_rutgersdelivery.py' file
3. In order to check that our unit testing works, navigate to the command line and type 'poetry run pytest'
4. If the program outputs 'All tests passed' then the testing is successful.

Contributors

1. Akanksha Arun - [email protected]
2. Eshaan Mathur - [email protected]
3. Eoin O’Hare - [email protected]
4. Sidhu Arakkal - [email protected]
5. Mohammad Awais Zubair - [email protected]