Main

.github/workflows/nextjs.yml

@@ -7,7 +7,7 @@ name: Deploy Next.js site to Pages
 on:
     # Runs on pushes targeting the default branch
     push:
-        branches: ["master"]
+        branches: ["main"]
 
     # Allows you to run this workflow manually from the Actions tab
     workflow_dispatch:

README.md

@@ -1,36 +1,199 @@
+# MapQaTor Frontend
+
 This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+## Project Setup
+
+Follow the step by step installation procedure to install and run this on your machine.
+
+## Prerequisites
+
+Make sure you have node installed in your device.
+
+**`NodeJs`**: Install Nodejs from [here](https://nodejs.org/en/download/)
+
+## Installation <a name="configuration"></a>
+
+
+1.  Clone the repo
+
+```sh
+git clone https://github.com/mapqator/mapqator.github.io.git
+```
+
+2.  If you don't have git installed in your device then download zip
+3.  After installation or download go to the repository and open command line.
+
+### Configuring
+
+
+2. Install NPM packages
 
-First, run the development server:
+```sh
+npm install
+```
+
+3.  Ensure backend is configured and running correctly on "http://localhost:5000" (note the port number)
+
+#### Run the project
+
+Go to your favourite code editor and run
 
-```bash
+```sh
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
+You should find that the project is working!
+
+## Adding new Map APIs
+
+Add or edit files in the `src/tools` and `src/mapServices` directories.
+
+
+# Data Collection Tools
+
+<!-- {
+        "id": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
+        "displayName": {
+          "text": "Eiffel Tower"
+        },
+        "shortFormattedAddress": "Eiffel Tower, Av. Gustave Eiffel, Paris",
+        "location": {
+          "latitude": 48.858370099999995,
+          "longitude": 2.2944812999999997
+        },
+        "uuid": 1741455661378,
+        "mapService": "googleMaps",
+        "hidden": false
+      } -->
+
+## Text Search Object
+
+| Field Name       | Description                                      |
+|------------------|--------------------------------------------------|
+| `id`          | A location identifier (e.g., a Place ID)                  |
+| `displayName`   | Display name of the location.                           |
+| `shortFormattedAddress` | Short address of the location.                  |
+| `location`       | Latitude and longitude of the location.                |
+| `mapService`     | Map service used for the search (e.g., googleMaps).    |
+
+## Place Details Object
+
+Attributes of the place details object are unique to the Map Service used. This need to be specified in the adapter. Attributes should be subset of the following:
+
+`[  "location",
+	"shortFormattedAddress",
+	"accessibilityOptions",
+	"businessStatus",
+	"googleMapsUri",
+	"primaryType",
+	"internationalPhoneNumber",
+	"nationalPhoneNumber",
+	"priceLevel",
+	"rating",
+	"regularOpeningHours",
+	"userRatingCount",
+	"websiteUri",
+	"allowsDogs",
+	"curbsidePickup",
+	"delivery",
+	"dineIn",
+	"editorialSummary",
+	"evChargeOptions",
+	"fuelOptions",
+	"goodForChildren",
+	"goodForGroups",
+	"goodForWatchingSports",
+	"liveMusic",
+	"menuForChildren",
+	"parkingOptions",
+	"paymentOptions",
+	"outdoorSeating",
+	"reservable",
+	"restroom",
+	"servesBeer",
+	"servesBreakfast",
+	"servesBrunch",
+	"servesCocktails",
+	"servesCoffee",
+	"servesDessert",
+	"servesDinner",
+	"servesLunch",
+	"servesVegetarianFood",
+	"servesWine",
+	"takeout",
+	"generativeSummary",
+	"areaSummary"
+]
+` 
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+## Nearby Search Object
 
-## Learn More
+| Field Name       | Description                                      |
+|------------------|--------------------------------------------------|
+| `locationBias`   | A location identifier (e.g., a Place ID) specifying the place around which to search |
+| `type`           | Type of places being searched (e.g., restaurant).                |
+| `keyword`        | A keyword for refining the search (can be empty).          |
+| `minRating`      | Minimum rating filter for the search (e.g., 4).        |
+| `priceLevels`| List of price levels allowed (e.g., PRICE_LEVEL_MODERATE, PRICE_LEVEL_EXPENSIVE).                       |
+| `rankPreference`     | Ranking preference for search results (RELEVANCE, DISTANCE, etc.).                     |
+| `maxResultCount` | Maximum number of results to return.                |
+| `places` | List of places matching the query criteria.  |
+| `routingSummaries` | List of navigation details for reaching the places.                |
 
-To learn more about Next.js, take a look at the following resources:
+## Compute Routes Object
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+<!-- "origin": "ChIJD3uTd9hx5kcR1IQvGfr8dbk",
+        "destination": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
+        "intermediates": [
+          "ChIJOYNm1DBu5kcRZwdtKBzyq6k",
+          "ChIJATr1n-Fx5kcRjQb6q6cdQDY"
+        ],
+        "travelMode": "DRIVE",
+        "optimizeWaypointOrder": true,
+        "routeModifiers": {
+          "avoidTolls": true,
+          "avoidHighways": true,
+          "avoidFerries": false
+        },
+        "routes":  -->
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+| Field Name       | Description                                      |
+|------------------|--------------------------------------------------|
+| `origin`         | Origin location identifier.                  |
+| `destination`    | Destination location identifier.                  |
+| `intermediates`  | List of intermediate locations.                  |
+| `travelMode`     | Mode of travel (e.g., DRIVE, WALK).                  |
+| `optimizeWaypointOrder` | Optimize the order of waypoints.                  |
+| `routeModifiers` | Modifiers for the route (e.g., avoidTolls).                  |
+| `routes`         | List of routes from origin to destination.                  |
 
-## Deploy on Vercel
+## Search Along Route Object
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+ <!-- "type": "restaurant",
+        "minRating": 0,
+        "priceLevels": [],
+        "rankPreference": "RELEVANCE",
+         "origin": "ChIJD3uTd9hx5kcR1IQvGfr8dbk",
+        "destination": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
+        "travelMode": "DRIVE",
+        "routeModifiers": {},
+        "maxResultCount": 5,
+        "places": [],
+        "routes": [] -->
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+| Field Name       | Description                                      |
+|------------------|--------------------------------------------------|
+| `type`           | Type of places being searched (e.g., restaurant).                |
+| `minRating`      | Minimum rating filter for the search (e.g., 4).        |
+| `priceLevels`    | List of price levels allowed (e.g., PRICE_LEVEL_MODERATE, PRICE_LEVEL_EXPENSIVE).                       |
+| `rankPreference` | Ranking preference for search results (RELEVANCE, DISTANCE, etc.).                     |
+| `origin`         | Origin location identifier.                  |
+| `destination`    | Destination location identifier.                  |
+| `travelMode`     | Mode of travel (e.g., DRIVE, WALK).                  |
+| `routeModifiers` | Modifiers for the route (e.g., avoidTolls).                  |
+| `maxResultCount` | Maximum number of results to return.                |
+| `places`         | List of places matching the query criteria.  |
+| `routes`         | List of routes from origin to destination.                  |