Strapi Plugin Location

This plugin allows users to create location inputs and store latitude and longitude values as geometry types in a PostGIS database. It also provides functionality to filter items based on their location.

Caution 🖐⚠️

This plugin requires a PostgreSQL database with the PostGIS extension enabled (can be used on that database plugin will enable it for you if it can). Make sure you have a compatible database set up before using this plugin. For development I used postgis docker image from here: https://registry.hub.docker.com/r/postgis/postgis/

⚠️ Filtering by data in relations is not supported.

🙉 What does the plugin do for you?

✅ Provides a custom location input field for latitude and longitude values
✅ Display the location on a map and fine-tune it by moving a marker using drag-and-drop functionality, all without the need for a Google Maps API key.
✅ Handles storage of location values as geometry types in a PostGIS database
✅ Allows filtering of items based on their location
✅ Enables searching for items with the same location or within a specified range

🧑‍💻 Installation

Install the package with your preferred package manager using one of the commands bellow:

npm i @notum-cz/strapi-plugin-location

yarn add @notum-cz/strapi-plugin-location

Create or modify file config/plugins.js and include the following code snippet:

module.exports = ({ env }) => ({
    "location-plugin": {
        enabled:  true,
    },
});

run npm build or yarn build to get the plugin activated in the admin UI
extend config/middlewares.js as shown in this example:

export default [
  "strapi::errors",
  {
    name: "strapi::security",
    config: {
      contentSecurityPolicy: {
        useDefaults: true,
        directives: {
          "connect-src": ["'self'", "https:"],
          "img-src": [
            "'self'",
            "data:",
            "blob:",
            "https://market-assets.strapi.io",
            "https://tile.openstreetmap.org",
            "https://a.tile.openstreetmap.org",
            "https://b.tile.openstreetmap.org",
            "https://c.tile.openstreetmap.org",
          ],
          "media-src": ["'self'", "data:", "blob:"],
          upgradeInsecureRequests: null,
        },
      },
    },
  },
  "strapi::cors",
  "strapi::poweredBy",
  "strapi::logger",
  "strapi::query",
  "strapi::body",
  "strapi::session",
  "strapi::favicon",
  "strapi::public",
];

⚙️ Usage

To use a custom input field for latitude and longitude go to the Content-type-builder of your application –> select a desired content-type -> click add another field -> select Cutstom tab -> name the field and hit the save button.
To search or filter items based on their location use url parameter location in the following formats.

For example for a content-type named Restaurant with a field coords containing the coordinates the url with the location query would be:

localhost:1337/api/restaurants?$location[coords]=49.200949303006055,16.623833585841673,5000

This will return a list of restaurants within 5000m of the point specified by the coordinates. Replace the collection name restaurant and the field name coords with the name of your collection name and the field containing the coordinates. The last number (5000) is range and is not required. Also this format is supported:

localhost:1337/api/restaurants?$location[coords][lat]=49.200949303006055&$location[coords][lng]=16.623833585841673

🛣️ Road map

Are any of these features significant to you? Please show your support by giving a thumbs up on the linked issues. This will help us assess their priority on the roadmap.

Q4 2023

🐛 Bugs

We manage bugs through GitHub Issues.
If you're interested in helping us, you would be a rock ⭐.

🧔 Authors

The main star: Dominik Míček https://github.com/Ballonek
Original Maintainer: Ondřej Mikulčík https://github.com/omikulcik
Active Maintainer: Ondřej Mikulčík https://github.com/dominik-juriga
Project owner: Ondřej Janošík

Wanna be here? Open an issue (and solve it), PR or share improvement idea and you will become a listed contributor.

💬 Community

Join our Discord server to discuss new features, implementation challenges or anything related to this plugin.

🚀 Created with passion by Notum Technologies

Official STRAPI partner and Czech based custom development agency.
We're passionate about sharing our expertise with the open source community, which is why we developed this plugin. 🖤

🎯 How can Notum help you with your STRAPI project?

✔️ We offer valuable assistance in developing custom STRAPI, web, and mobile apps to fulfill your requirements and goals..
✔️ With a track record of 100+ projects, our open communication and exceptional project management skills provide us with the necessary tools to get your project across the finish line.
📅 To initiate a discussion about your Strapi project, feel free to reach out to us via email at sales@notum.cz. We're here to assist you!

notum-cz / strapi-plugin-location

readme