@kortxyz/ogcapi-gpkg NPM

About The Project

Add standardbased geospatial capabilites to you API.

Product Name Screen Shot

Getting Started

This is an example of how to use this Fastify plugin in your own project.

Prerequisites

Install fastify through npm
```
npm install fastify
```

Installation

Install the plugin through npm
```
npm install @kortxyz/ogcapi-gpkg
```

Create a index.js

  const fastify = require('fastify')({
    logger: true
  })

  fastify.register(require('@kortxyz/ogcapi-gpkg'))

  fastify.listen({ port: 3000 }, (err, address) => {
    if (err) {
      fastify.log.error(err)
      process.exit(1)
    }
  })

Start the server
```
node index.js
```

API

Options

@kortxyz/ogcapi accepts the options object:

{
  baseUrl: 'http://127.0.0.1:3000',
  gpkg: 'data/naturcenter.gpkg',
  skipLandingpage: true,
}

prefix (Default: "" ): Standard .
baseUrl (Default: undefined): baseurl for the links in the json responses, prefix are added automatically.
gpkg (Default: generated.gpkg): path to the OGC Geopackage used a datastore for this API
skipLandingpage (Default: false): skip creating a root landingpage. Fx if you are not giving the routes a prefix.

Roadmap

OGC API - Common
- part 1: Core
OGC API - Features
- part 1: Core
- part 2: CRS by Reference
- part 3: Filtering
- part 4: Create, Replace, Update and Delete
OGC API - Tiles
- part 1: Core
OGC API - Styles
- part 1: Core

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!