Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lblod/app-gn-embeddable
https://github.com/lblod/app-gn-embeddable
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lblod/app-gn-embeddable
- Owner: lblod
- License: mit
- Created: 2021-04-23T19:47:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-16T09:14:28.000Z (11 months ago)
- Last Synced: 2024-04-16T06:36:57.011Z (9 months ago)
- Language: Elixir
- Size: 38.1 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# DEPRECATED: app-gn-embeddable
> [!WARNING]
> This repository is no longer maintained and is thus unsupported.
> Please look into the documentation of [@lblod/embeddable-say-editor](https://github.com/lblod/frontend-embeddable-notule-editor) instead to get more information on how to setup the say-editor in your project.
Backend systems and editor built on top of the Besluit and Mandaat model and application profile as defined on:
http://data.vlaanderen.be/ns/besluit
http://data.vlaanderen.be/doc/applicatieprofiel/besluit-publicatie/
http://data.vlaanderen.be/ns/mandaat
http://data.vlaanderen.be/doc/applicatieprofiel/mandatendatabank/
This repository is a [mu-project](https://github.com/mu-semtech/mu-project), it includes the minimal set of services required to run the embeddable editor. In essence this repository is the minimal version of app-gelinkt-notuleren.
## requirements and assumptions
This project was tested on ubuntu 18.04 and 20.04, but should work on most systems that run docker and docker-compose. A linux based system is recommended, but we welcome any feedback you might have when running this system on macOS or windows.
* a recent version of [docker needs to be installed](https://docs.docker.com/get-docker/)
* a recent version of [docker-compose needs to be installed](https://docs.docker.com/compose/install/)
* some basic shell experience is recommended
## getting started
1. make sure all [requirements](#requirements-and-assumptions) are met
2. clone this repository
```
$ git clone https://github.com/lblod/app-gn-embeddable
```
3. run the project
```
$ cd app-gn-embeddable
$ docker-compose up -d
```
After running these commands you should have a basic version of embeddable running on port 80.
## providing a custom version of embeddable
This stack contains the default build of embeddable. It's recommended to build your own custom version with the plugins that are interesting to your use case.
The [frontend-embeddable-notule-editor](https://github.com/lblod/frontend-embeddable-notule-editor#frontend-embeddable-notule-editor) has detailed instructions on building your own version of embeddable. Once build you should have a dist folder with the necessary files.
Add the dist folder to the data directory of this project and add create a `docker-compose.override.yml` file with the following contents:
```
version: "3.4"
services:
editor:
volumes:
- ./data/dist:/app
```
Finally run `docker-compose up -d` again to have your custom version running.
## adding SSL [BETA]
We've provided a configuration that automatically creates and configures ssl certificates through letsencrypt.
edit the included `.env` file to include the https docker-compose file:
```
COMPOSE_FILE=docker-compose.yml:docker-compose.https.yml:docker-compose.override.yml
```
next edit the docker-compose.override.yml file to add your domain name:
```
version: "3.4"
x-logging: &default-logging
driver: "json-file"
options:
max-size: "10m"
max-file: "3"
services:
identifier:
environment:
VIRTUAL_HOST: "editor.awesomecorp.com"
LETSENCRYPT_HOST: "editor.awesomecorp.com"
LETSENCRYPT_EMAIL: "[email protected]" # get an email if your ssl certificate expires or something else goes wrong
```
## overview of services
[overview of services](https://raw.githubusercontent.com/lblod/app-gn-embeddable/master/docs/gn-embeddable-services-overview.svg)
* [mu-identifier](https://github.com/mu-semtech/mu-identifier)
* [mu-dispatcher](https://github.com/mu-semtech/mu-dispatcher)
* [mu-cl-resources](https://github.com/mu-semtech/mu-cl-resources)
* [mu-cache](https://github.com/mu-semtech/mu-cache)
* [mu-authorization](https://github.com/mu-semtech/mu-authorization/)
* [delta-notifier](https://github.com/mu-semtech/delta-notifier/)
* [frontend-embeddable](https://github.com/lblod/frontend-embeddable-notule-editor)
* [codex-reverse-proxy](https://github.com/lblod/codex-reverse-proxy-service)