Skip to content

Latest commit

 

History

History
128 lines (83 loc) · 4.68 KB

README.EN.rst

File metadata and controls

128 lines (83 loc) · 4.68 KB

open_producten

Version: 0.0.1
Source:https://github.com/maykinmedia/open-producten
Keywords:products

Place for municipalities to manage product types and products to be able to use them in other applications. (Nederlandse versie)

Developed by Maykin B.V..

Introduction

Open Producten is an application where product types and products can be managed in a single place. Other applications like Open Inwoner and Open Formulieren can integrate Open Producten using its REST API to for example show product type information, create products or to get the current price for a product type.

This Project is a proof of concept at the moment.

The data model of the Open Producten PoC is based on the model from Open Inwoner with a few changes for integrations with Open Inwoner en Open Formulieren.

Open Producten can store Product types and products, A product type is for example a parking permit and contains all relevant information such as what the rules are and how different parking zones work etc. A product in this example is a parking permit of a person and contains in this instance the license plate and personal information.

API specification

Lint OAS Generate SDKs Generate Postman collection

Version Release date API specification
latest n/a ReDoc, Swagger

Een api token can be created in Open Producten admin -> Users -> Tokens.

See: All versions and changes

Developers

Build status Coverage Code style Supported Python version

This repository contains the source code for open_producten. To quickly get started, we recommend using the Docker image. You can also build the project from the source code. For this, please look at INSTALL.rst.

Open producten consists of three apps:

  • product types
  • products
  • locations (& organisations)

Quickstart

  1. Download and run open_producten:

    $ wget https://raw.githubusercontent.com/maykinmedia/open-producten/main/docker-compose.yml
    $ docker-compose up -d --no-build
    $ docker-compose exec web src/manage.py loaddata demodata
    $ docker-compose exec web src/manage.py createsuperuser
  2. In the browser, navigate to http://localhost:8000/ to access the admin and the API.

References

License

Copyright © Maykin 2024

Licensed under the EUPL