An open API service indexing awesome lists of open source software.

https://github.com/algosup/2024-2025-project-3-quickest-path-team-6

PathQuick is a high-performance software solution designed to calculate the quickest path between two landmarks in the United States.
https://github.com/algosup/2024-2025-project-3-quickest-path-team-6

algorithms astar-algorithm cpp csv dijkstra-shortest-path json opensource rest-api server weighted-graphs xml

Last synced: 9 months ago
JSON representation

PathQuick is a high-performance software solution designed to calculate the quickest path between two landmarks in the United States.

Awesome Lists containing this project

README

          

# PathQuick - Chart Your Fastest Adventure! 🚀

Welcome to PathQuick, the ultimate guide to uncovering the quickest routes between! Whether you're a virtual road tripper or a logistical mastermind, PQ is here to deliver blazing-fast route calculations and seamless navigation.

## What Is PathQuick?

PathQuick is more than a piece of software—it's your trusty digital cartographer. With its cutting-edge algorithms, PQ scours the labyrinth of roads connecting the landmarks and delivers routes with precision and efficiency.

## Why PathQuick Stands Out?

PathQuick isn't just about getting you from Point A to Point B; it’s about doing so with flair and finesse. We've poured our love for problem-solving and optimization into this project to ensure:

Speed: Responses so quick, you’ll think we have a crystal ball.

Flexibility: Love XML? Adore JSON? We’ve got you covered.

## How Does It Work?

1. Give It a Quest:
- Feed PathQuick the IDs of your starting and ending landmarks.

2. Give It a Format:
- Feed PathQuick the format of the expected answer.

3. Sit Back and Relax:
- Our REST API takes over, conjuring up the optimal path in the blink of an eye.

4. Revel in the Results:
- PQ doesn’t just deliver the travel time; it narrates the story of your journey through an ordered list of landmarks.




## Behind The Scenes Magic

PathQuick is fueled by the raw computational power of C++, honed to perfection for speed and reliability. It wields algorithms that have been meticulously designed to navigate massive datasets, crunching through colossal .csv files with ease.

But we didn’t stop there! PQ also includes a robust data validation tool to ensure every connection is rock-solid. Bidirectional roads? Fully connected graph? We’ve checked it all so you don’t have to.

Go forth, chart your fastest adventure, and remember—all roads lead to PathQuick! 🌟

## How To Use PathQuick?

PathQuick is available on both macOS and Windows.

To benefit from PathQuick's algorithm and pathfinding, you just need to perform few steps.

1. **Obtain the project source**

**Clone the repository**:

- Open your terminal
- Clone this repository by typing `git clone https://github.com/algosup/2024-2025-project-3-quickest-path-team-6`
- Type `cd 2024-2025-project-3-quickest-path-team-6` to get into the project's directory
- Type `cd Src` to get into the source folder

**Get the source code via a release**:

- Get the latest release [here](https://github.com/algosup/2024-2025-project-3-quickest-path-team-6/releases)
- Download the `.zip` file
- Get into the project's directory

2. **Assure everything is set up**

- Assure a .csv file is located in the current directory

3. **Run the program**

You can run the program in various ways:

- Run the `pathQuickLauncher` file, which will launch both the server and the application in dedicated terminal windows
- Run separately both files, the `startServer` file in the Server folder and the `startClient` file in the Client folder

## Collaborators

| Picture | Full name | Role | Links |
| ----- | --------------- | ------------------------ | ----------------------------------------------------------------- |
| | Evan UHRING | Project manager | [LinkedIn](https://www.linkedin.com/in/evan-uhring-72911b293/) [GitHub](https://github.com/Evan-UHRING) |
| | Manech LAGUENS | Program manager | [LinkedIn](https://www.linkedin.com/in/manech-laguens-020127293/) [GitHub](https://github.com/Manech-Laguens) |
| | Enzo GUILLOUCHE | Tech lead| [LinkedIn](https://www.linkedin.com/in/enzoguillouche/) [GitHub](https://github.com/EnzoGuillouche) |
| | Pavlo PRENDI | Software engineer | [LinkedIn](https://www.linkedin.com/in/pavlo-prendi-674777309/) [GitHub](https://github.com/PavloPrendi) |
| | Mariem ZAIANE | Software engineer | [LinkedIn](https://www.linkedin.com/in/mariem-zaiane-2b2165225/) [GitHub](https://github.com/Mariem-Zaiane) |
| | Maxime THIZEAU | Quality assurance | [LinkedIn](https://www.linkedin.com/in/maxime-thizeau-0b311a293/) [GitHub](https://github.com/MaximeTAlgosup) |
| | Aurélien FERNANDEZ | Tech writer | [LinkedIn](https://www.linkedin.com/in/aurélien-fernandez-4971201b8/) [GitHub](https://github.com/aurelienfernandez) |