Skip to content

Commit

Permalink
chore(docs): document components and licenses
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jumpy-Squirrel
Jumpy-Squirrel committed Oct 17, 2024
1 parent b551066 commit cc4171f
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 2 deletions.
2 changes: 1 addition & 1 deletion LICENSE
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Eurofurence e.V.
Copyright (c) 2024 Eurofurence e.V.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 22 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,28 @@

A helm chart that can deploy the Eurofurence Registration System.

The Eurofurence Registration System is Open Source software,
all major components are [MIT licensed](https://github.com/eurofurence/reg-helm-chart/blob/main/LICENSE).

| Component | Description |
|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [Helm Chart](https://github.com/eurofurence/reg-helm-chart) | helm chart used to deploy the registration system |
| | |
| [Attendee Service](https://github.com/eurofurence/reg-attendee-service) | backend micro-service providing a central attendee-related REST API |
| [Auth Service](https://github.com/eurofurence/reg-auth-service) | backend micro-service that bridges registration and the identity provider |
| [Mail Service](https://github.com/eurofurence/reg-mail-service) | backend micro-service for rendering mails based on templates and sending them |
| [Payment Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for dues and payments booking and accounting |
| [Room Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for rooms, roomgroups, and hotel booking |
| | |
| [Concardis Adapter](https://github.com/eurofurence/reg-payment-cncrd-adapter) | backend micro-service that interfaces between the registration system and the Paylink API |
| | |
| [Frontend](https://github.com/eurofurence/reg-frontend) and [Component Library](https://github.com/eurofurence/reg-component-library) | Frontend and component library for end user registration |
| [Onsite UI](https://github.com/eurofurence/reg-onsite-ui) | UI used by the onsite registration team |
| [Regsys Classic](https://github.com/eurofurence/reg-regsys-classic) | Admin UI (and what's left of the regsys we used in the years 2001-2019) |

The Eurofurence Registration System depends on the [Eurofurence Identity Provider](https://github.com/Thiritin/identity),
which is also Open Source software (Apache 2.0).

## Installation

To use, you just need helm in your path.
Expand Down
2 changes: 1 addition & 1 deletion charts/eurofurence-registration-system/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: eurofurence-registration-system
version: 0.0.29
version: 0.0.30
description: A helm chart that can deploy the Eurofurence Registration System.
type: application
home: https://github.com/eurofurence/reg-helm-chart
22 changes: 22 additions & 0 deletions charts/eurofurence-registration-system/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,28 @@

A helm chart that can deploy the Eurofurence Registration System.

The Eurofurence Registration System is Open Source software,
all major components are [MIT licensed](https://github.com/eurofurence/reg-helm-chart/blob/main/LICENSE).

| Component | Description |
|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [Helm Chart](https://github.com/eurofurence/reg-helm-chart) | helm chart used to deploy the registration system |
| | |
| [Attendee Service](https://github.com/eurofurence/reg-attendee-service) | backend micro-service providing a central attendee-related REST API |
| [Auth Service](https://github.com/eurofurence/reg-auth-service) | backend micro-service that bridges registration and the identity provider |
| [Mail Service](https://github.com/eurofurence/reg-mail-service) | backend micro-service for rendering mails based on templates and sending them |
| [Payment Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for dues and payments booking and accounting |
| [Room Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for rooms, roomgroups, and hotel booking |
| | |
| [Concardis Adapter](https://github.com/eurofurence/reg-payment-cncrd-adapter) | backend micro-service that interfaces between the registration system and the Paylink API |
| | |
| [Frontend](https://github.com/eurofurence/reg-frontend) and [Component Library](https://github.com/eurofurence/reg-component-library) | Frontend and component library for end user registration |
| [Onsite UI](https://github.com/eurofurence/reg-onsite-ui) | UI used by the onsite registration team |
| [Regsys Classic](https://github.com/eurofurence/reg-regsys-classic) | Admin UI (and what's left of the regsys we used in the years 2001-2019) |

The Eurofurence Registration System depends on the [Eurofurence Identity Provider](https://github.com/Thiritin/identity),
which is also Open Source software (Apache 2.0).

## Configuration

TODO add documentation here.
Expand Down

0 comments on commit cc4171f

Please sign in to comment.