# Serverless Route Optimization
This solution was created to help customers get started with an easy to deploy end-to-end route optimization solution.
It was released and demoed OnAir live at Re:Mars 2022 on 6/22/22: https://www.youtube.com/watch?v=g5Kln1hDEZQ
To test a Sample Version of the App before deploying, visit: http://geoconvrp1.s3-website-us-east-1.amazonaws.com/#2.23/37.25/-90.95
## Architecture
## Deploying the Project
### Prerequistes:
To use the SAM CLI, you need the following tools:
- [AWS account](https://aws.amazon.com/free/?trk=ps_a134p000003yBfsAAE&trkCampaign=acq_paid_search_brand&sc_channel=ps&sc_campaign=acquisition_US&sc_publisher=google&sc_category=core&sc_country=US&sc_geo=NAMER&sc_outcome=acq&sc_detail=%2Baws%20%2Baccount&sc_content=Account_bmm&sc_segment=438195700994&sc_medium=ACQ-P%7CPS-GO%7CBrand%7CDesktop%7CSU%7CAWS%7CCore%7CUS%7CEN%7CText&s_kwcid=AL!4422!3!438195700994!b!!g!!%2Baws%20%2Baccount&ef_id=Cj0KCQjwsuP5BRCoARIsAPtX_wEmxImXtbdvL3n4ntAafj32KMc_sXL9Z-o8FyXVQzPk7w__h2FMje0aAhOFEALw_wcB:G:s&s_kwcid=AL!4422!3!438195700994!b!!g!!%2Baws%20%2Baccount&all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all)
- AWS SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
- Python 3.9 or later - [download the latest of version of python](https://www.python.org/downloads/)
- An [AWS Identity and Access Managment](https://aws.amazon.com/iam/) role with appropriate access
### This Sample Includes:
- *template.yaml*: Contains the AWS SAM template that defines the application's AWS resources. Resources outlined in the template include Location Service Resources for Maps, Places, and Routes, Congito Authorizer, Lambda Function, API Gateway REST API, and Location Service Resources which includes a Place Index for Amazon Location Service
- *route-optimizer-function/*: Contains the Lambda function logic that performs the optimization of routes. The function takes in a series of points, and returns the optimized route data.
- *dependencies/*: Contains dependencies that are added as a Lambda layer upon deployment. Dependencies include Boto3 and OR-Tools.
- *index_route_opt.html*: This file contains the front end code, written in HTML and JS. It uses Amplify Geo to create the map resource from Amazon Location Service, and MapLibre libraries to add layers. It can be deployed directly in a browser.
### Deploy the Sam-App:
1. Use `git clone https://github.com/aws-samples/serverless-route-optimization` to clone the repository to your environment where AWS SAM and python are installed.
2. Use ``cd ~/serverless-route-optimization``to change into the project directory containing the template.yaml file SAM uses to build your application.
3. Use ``sam build`` to build your application using SAM. You should see:
4. Use `sam deploy --guided` to deploy the application to your AWS account. Enter unique values to name your the application resources.
5. Once your stack has deployed sucessfully, you will see 4 output parameters returned below. For all 4 output parameters, navigate to the index_route_opt.html file and replace the coresponding '' name with the output values from the SAM deployment stack (values can be found at lines 197-200 in index_route_opt.html).
## Testing the Application
1. The index_route_opt.html is designed to work directly in your favorite browser without needing to host locally. Once you have edited the file to add the necessary outputs from the SAM deployment, you can drag and drop the file into your browser tab to begin testing!
2. Begin clicking points to optimize routes. Note by default, the optimized route will return to the origin, which is the first point selected.
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This library is licensed under the MIT-0 License. See the LICENSE file.