Added issue templates as well as updated readme

This commit is contained in:
Toastie 2025-01-14 00:44:04 +13:00
parent daf6b89056
commit 8e7c2a7374
Signed by: toastie_t0ast
GPG key ID: 0861BE54AD481DC7
4 changed files with 130 additions and 0 deletions

View file

@ -0,0 +1,56 @@
name: "Bug Report"
description: File a bug report.
labels: ["bug"]
body:
- type: dropdown
attributes:
label: Which version of EllieHub are you using?
multiple: false
options:
- label: Windows x64
- label: Windows arm64
- label: Linux x64
- label: Linux arm64
- label: MacOS x64
- label: MacOS arm64
- label: I compiled from source
validations:
required: true
- type: "textarea"
attributes:
label: "Description"
description: "Give a concise description of the problem"
validations:
required: true
- type: "textarea"
attributes:
label: "Reproduction Steps"
description: "Enumerate the steps needed to reproduce the behavior"
value: "1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error"
validations:
required: true
- type: "textarea"
attributes:
label: "Expected Behavior"
description: "Describe what you expected to happen"
validations:
required: true
- type: "textarea"
attributes:
label: "Actual Behavior"
description: "Describe what actually happened"
validations:
required: false
- type: "textarea"
attributes:
label: "Screenshots"
description: "If applicable, add screenshots to help explain your problem"
validations:
required: false
- type: "textarea"
attributes:
label: "Notes"
description: "Add any other context about the problem here"
placeholder: "eg. OS version, etc"
validations:
required: false

View file

@ -0,0 +1,30 @@
name: "Feature Request"
description: Suggest an idea for this project.
labels: ["enhancement"]
body:
- type: "textarea"
attributes:
label: "Is your feature request related to a problem?"
description: "If so, describe what the problem is"
placeholder: "eg. I'm always frustrated when [...]"
validations:
required: false
- type: "textarea"
attributes:
label: "Describe the feature you'd like"
description: "Describe what you want to happen"
placeholder: "eg. The application should do [...] then [...]"
validations:
required: true
- type: "textarea"
attributes:
label: "What alternatives have you considered?"
description: "Feel free to mention similar applications if you feel this will get your point across better"
validations:
required: false
- type: "textarea"
attributes:
label: "Additional context"
description: "Add any other context or screenshots about the feature request here"
validations:
required: false

View file

View file

@ -1,2 +1,46 @@
# EllieHub # EllieHub
EllieHub is a cross-platform user-friendly desktop application designed for management of [EllieBot][EllieWebsite] Discord bot instances.
Download it [here][EllieHubReleases].
For more information about this project, please visit the [wiki][ToastielabWiki].
## Features
- Install, update, and remove Ellie bots.
- Install and update dependencies used by Ellie to play music.
- Easy access to the settings of each Ellie bot.
- Start and stop your bots directly from the Hub.
- Create backups of your bots whenever you want.
- Watch logs of your bots in real time and have them saved automatically for later inspection.
- Works on Windows, Linux, and macOS.
## Screenshots
### Coming Soon!
## License
EllieHub, a desktop application for managing instances of the EllieBot Discord bot.
Copyright (C) 2024 Toastie_t0ast & EllieBotDevs
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
[EllieWebsite]: https://elliebot.net/
[HomeView]: ./.forgejo/readme_assets/elliehub_home.png
[ConfigView]: ./.forgejo/readme_assets/elliehub_config.png
[BotConfigeView]: ./.forgejo/readme_assets/elliehub_botconfig.png
[ToastielabWiki]: https://toastielab.dev/EllieBotDevs/EllieHub/wiki
[EllieHubReleases]: https://toastielab.dev/EllieBotDevs/EllieHub/releases/latest