Skip to content

DeutscheModelUnitedNations/munify-delegator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MUNify DELEGATOR

DELEGATOR stands for DELEGation AdministratOR

MUNify DELEGATOR is a Software to manage the Registration Process and organizational Matters of a Model United Nations Conference. It is part of the MUNify Project, which aims to provide a comprehensive Software Suite for Model United Nations Conferences. MUNify is an Open Source Project by the german non-profit organization Deutsche Model United Nations (DMUN) e.V.

Disclaimer: MUNify DELEGATOR is currently in an early stage of development and not yet ready for production use. We are working hard to provide a stable Version as soon as possible.

We are happy to recieve feedback, contributions and donations. Please see below for more information.

Features

  • Registration Process: Manage the Registration Process for Delegations, Single Applicants and Supervisors
  • Delegation Assignment: Assign Delegations to Countries and Committees
  • Delegation Management: Manage Delegations and track their Status (like Payment Status)

Develop Locally

Make sure you have Docker and Bun installed. (You might need to have Node.js installed too for managing the database ORM prisma)

  1. Clone the Repository
git clone https://github.com/DeutscheModelUnitedNations/munify-delegator.git
  1. Install Dependencies
bun install
  1. Start the Development Server
bun run dev

# if you want to separate docker containers and the actual dev server you can use
bun run dev:docker # starts all necessary dev dependencies e.g. postgres
bun run dev:server # starts the actual dev server (vite&sveltekit)
  1. (Optionally) install git hooks for automated linting etc.
bunx lefthook install

Deployment

The easiest way to deploy delegator on your own hardware is to use our provided docker images. You can find an example docker compose file in the example directoy. Please note that delegator relies on an OIDC issuer to be connected and properly configured. We recommend ZITADEL but any issuer of your choice will work. There are some additional instructions on this topic to be found in the example compose file.

FAQ

Can I use this for my conference outside of DMUN? Yes. We encourage and allow usage for other conferences. Please see our license for more detailed information on this.

Note that the project is still under development and it is not recommended to use it without our consultation for a conference at the moment. The current state of the of the App is tested on a few DMUN conferences. If you are interested in using it, please contact us via the discussion section of this repository. We are happy to help you with the setup and usage, as long as you use it for your own conferences in line with our non-profit spirit.

Note also that this is primarily a project for DMUN conferences and might not be 100% suitable for your conferences needs and compatable with your rules of procedure. If you want guidlines on how to adapt the Code to your needs, please contact us via the discussion section of this repository. We are also happy to help.

Ok, but how? You would need to deploy the app yourself, on your own servers and do all the neccessary setups. This can be an owerwhelming task so feel free to contact us when you need help. In some cases it might be possible for us to run the infrastructure and grant you access, please contact us in case you would like to know more about this. Depending on the use case and complexity, we might need to charge a service fee.

Can I help you building the project? Yes, you can! Please refer to the contributing section below.

Can you add a feature? For feature suggestions, please post in the discussion section of this repository. You can find it here. If you want to write it yourself, please see the contributing section below.

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

By contributing you agree to release your contribution under the projects license.

License

This aspect is work in progress since the project is currently in its development phase. If you want to use the project or one of its components nonetheless, please contact us via the discussion section.

LICENSE.md

Support us / Donations

You can support our work by donating to our non-profit organization Deutsche Model United Nations (DMUN) e.V.. Please contact our board for details on how to donate by sending an email to [email protected].

All donations are tax deductible in Germany and we are happy to provide you with a donation receipt. The money will be used to support our development of MUNify if you don't specify a different purpose.