@kortxyz/ogcapi-gpkg

KORTxyz - ogcapi-gpkg

Fastify routes that follows the OGC standard.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Add standardbased geospatial capabilites to you API.

(back to top)

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

1. Install the plugin through npm

   npm install @kortxyz/ogcapi-gpkg

2. 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)
       }
     })

3. Start the server

   node index.js

(back to top)

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.

(back to top)

Roadmap

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

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

(back to top)

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!

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

KORTxyz [e-mail]

Project Link: https://github.com/kortxyz/ogcapi-gpkg

(back to top)

Acknowledgments

(back to top)