https://github.com/am2222/strapi-plugin-postgis
Add native postgis support to strapi.
https://github.com/am2222/strapi-plugin-postgis
gis postgis strapi-plugin strapipluginweek
Last synced: 3 months ago
JSON representation
Add native postgis support to strapi.
- Host: GitHub
- URL: https://github.com/am2222/strapi-plugin-postgis
- Owner: am2222
- Created: 2022-06-03T16:33:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T16:52:30.000Z (about 2 years ago)
- Last Synced: 2025-10-22T05:52:52.000Z (8 months ago)
- Topics: gis, postgis, strapi-plugin, strapipluginweek
- Language: JavaScript
- Homepage: https://am2222.github.io/strapi-plugin-postgis/
- Size: 24.8 MB
- Stars: 42
- Watchers: 5
- Forks: 15
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://am2222.github.io/strapi-plugin-postgis/)
Add native postgis support to strapi.
[](https://github.com/am2222/strapi-plugin-postgis/actions/workflows/npm-publish.yml) [](https://github.com/am2222/strapi-plugin-postgis/actions/workflows/docs-publish-github.yml)
---
## Under Development
## How does it work?
Since Strapi does not support native database formats I convert requests before they being sent to the querybuilder and convert all the geometry objects to the `geojson`.
## Requirements
Strapi Version 4.5.0 and up.
## Installation
Setup your strapi app as usual
```javascript
npx create-strapi-app@latest my-project --quickstart
```
Install `pg` and `strapi-plugin-postgis`
```javascript
npm install pg --save
npm i strapi-plugin-postgis
```
**Make sure to config your strapi to use `postgrs` database as backend, Use this link in case you need any help with this step (https://strapi.io/blog/postgre-sql-and-strapi-setup)**
**Make sure to install postgis on your database server.**
* This plugin is only compatible with postgis versions 3.1 and 3.2*
Modify your middlewares as following to let strapi load `osm` tiles. Add `'*.tile.openstreetmap.org'` to the `img-src` as follows
```javascript
// ./config/middlewares.js
module.exports = [
'strapi::errors',
{
name: 'strapi::security',
config: {
contentSecurityPolicy: {
useDefaults: true,
directives: {
'img-src': ["'self'", 'data:', 'blob:', '*.tile.openstreetmap.org'],
upgradeInsecureRequests: null,
},
},
},
},
'strapi::cors',
'strapi::poweredBy',
'strapi::logger',
'strapi::query',
'strapi::body',
'strapi::session',
'strapi::favicon',
'strapi::public',
];
```
Run strapi and you should see the following line
```
[2022-06-03 10:47:25.194] info: Welcome to Strapi Postgis 🚀 + 🐘 + 🗺️ | 3.1 USE_GEOS=1 USE_PROJ=1 USE_STATS=1
```
Now in your content-types api folder modify `schema.json` and add a new column with the following format
```javascript
{
"kind": "collectionType",
.
.
.
"attributes": {
.
.
.
"geom": { //--> your column name. you can change to anything
"columnType": {
"type": "specificType",
"args": [
"geometry(POINT,4326)" //-> change this line according to the Supported Data Types section
]
},
"type": "customField", //->don't change this
"customField": "plugin::postgis.map" //->don't change this
}
}
}
```
## Supported Data Types
### POINT
```json
"geom": {
"columnType": {
"type": "specificType",
"args": [
"geometry(POINT,4326)"
]
},
"type": "customField",
"customField": "plugin::postgis.map"
}
```
* POINT Z (0 0 0)
* POINT ZM (0 0 0 0)
* POINT EMPTY
### LINESTRING
```json
"g_line": {
"columnType": {
"type": "specificType",
"args": [
"geometry(LINESTRING,4326)"
]
},
"type": "customField",
"customField": "plugin::postgis.map"
}
```
* LINESTRING EMPTY
### POLYGON
```json
"g_polygon": {
"columnType": {
"type": "specificType",
"args": [
"geometry(POLYGON,4326)"
]
},
"type": "customField",
"customField": "plugin::postgis.map"
}
```
* MULTIPOINT((0 0),(1 2))
* MULTIPOINT Z ((0 0 0),(1 2 3))
* MULTIPOINT EMPTY
* MULTILINESTRING((0 0,1 1,1 2),(2 3,3 2,5 4))
* MULTIPOLYGON(((0 0,4 0,4 4,0 4,0 0),(1 1,2 1,2 2,1 2,1 1)), ((-1 -1,-1 -2,-2 -2,-2 -1,-1 -1)))
* GEOMETRYCOLLECTION(POINT(2 3),LINESTRING(2 3,3 4))
* GEOMETRYCOLLECTION EMPTY
## TODO
- Add tests
- Support all the types
- Add query options like sort by distance, overlap and etc.
- Develop dashboard
- Add cool pg queries and tilings ;)
## Thanks to
* strapi-plugin-point-list for the idea of how to add a custom components to the strapi content types
* postgis knex plugin
* leaflet editor plugin
* strapi team
* and so many other stuff