Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.99 KB

File metadata and controls

48 lines (37 loc) · 1.99 KB

IdeaLync - internal bot for Solync

Features

  • Pitch Creator
    1. Posts a fillable form in the specified channel for pitch submissions
    2. Once submitted, pitches are then posted in a configured forum channel, where pitches are stored (#pitching-board)
  • Meet Scheduler
    1. Use /schedule command to open a modal for meeting information
    2. Posts in the configured channel once submitted
  • Role Selection
    1. Posts a selection in the configured channel.
    2. Select the specified roles defined in the config
  • Pitch Forwarding
    1. Use /forward to forward pitches from the #pitching-board to the #project-board (configurable channels)
    2. Add a message to the forwarded pitch so members can get clarification

Getting Started

Important

Please make sure to install uv. This project is optimized for uv. Also install Ruff.

To begin development and testing locally, please follow these steps in your terminal of choice:

  1. Install uv and Ruff (optional but recommended) first using a package manager or by directly installing it from uv's GitHub Releases and Ruff's GitHub Releases

  2. Clone the repo by running git clone https://github.com/SolyncSoftware/IdeaLync.git.

  3. Go inside the newly cloned folder (cd IdeaLync).

  4. Run uv sync to install the packages.

  5. Great! Now configure .env by populating the values in .env_example.

  6. Now run uv run idealync to run the bot.

  7. See the bot come to life! :)

Goals

  • Improve our workflow internally
  • Open source
  • Internal initiative-driven tasks with a Kanban Board.

Resources