Zum Hauptinhalt springen

Tools Development Setup

AI-Generated Content

This documentation page was initially generated by AI to bootstrap the documentation structure. Content may be incomplete or contain inaccuracies. We welcome contributions to improve it.

This guide covers setting up development environments for MUNify utility tools.

Badge Generator​

Prerequisites​

  • Node.js 18+
  • npm or yarn

Setup​

git clone https://github.com/DeutscheModelUnitedNations/badgeGenerator.git
cd badgeGenerator
npm install
npm run dev

Tech Stack​

  • HTML/CSS/JavaScript
  • PDF generation library
  • Canvas API for rendering

Streamline​

Prerequisites​

  • Go 1.21+ or Node.js 20+
  • Docker (for running services)

Setup​

git clone https://github.com/DeutscheModelUnitedNations/munify-streamline.git
cd munify-streamline

For local development:

go run main.go

Or with Docker:

docker compose up

Tech Stack​

  • Go or Node.js
  • REST API
  • YAML configuration

Other Tools​

Masterplan Slack​

git clone https://github.com/DeutscheModelUnitedNations/masterplan-slack.git
cd masterplan-slack
npm install

Requires:

  • Slack API credentials
  • Google Sheets API access

Development Guidelines​

Code Style​

  • Use consistent formatting
  • Follow language conventions
  • Comment complex logic

Testing​

Test your changes:

npm test
# or
go test ./...

Documentation​

Update docs when adding features.

Running the Full Stack​

To run all MUNify services together:

  1. Start PostgreSQL
  2. Start CHASE
  3. Start DELEGATOR
  4. Start Streamline

Use Docker Compose for convenience:

docker compose -f docker-compose.full.yml up