feat: initial commit

.dockerignore

@@ -0,0 +1,25 @@
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.idea
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/charts
+**/docker-compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

.github/workflows/docker-release.yml

@@ -0,0 +1,42 @@
+name: Docker Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/dotnet.yml

@@ -0,0 +1,25 @@
+name: .NET
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    name: "Build & Test"
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 7.0.x
+    - name: Add NuGet source
+      run: dotnet nuget add source --username oliverbooth --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/oliverbooth/index.json"
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore --configuration Release
+    - name: Test
+      run: dotnet test --no-build --verbosity normal

.github/workflows/prerelease.yml

@@ -0,0 +1,35 @@
+name: Tagged Pre-Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+-*"
+
+jobs:
+  prerelease:
+    name: "Tagged Pre-Release"
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 7.0.x
+
+    - name: Add GitHub NuGet source
+      run: dotnet nuget add source --username oliverbooth --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/oliverbooth/index.json"
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build -c Release
+
+    - name: Create Release
+      uses: "marvinpinto/action-automatic-releases@latest"
+      with:
+        repo_token: "${{ secrets.GITHUB_TOKEN }}"
+        prerelease: true

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Tagged Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  release:
+    name: "Tagged Release"
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 7.0.x
+
+    - name: Add GitHub NuGet source
+      run: dotnet nuget add source --username oliverbooth --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/oliverbooth/index.json"
+
+    - name: Restore dependencies
+      run: dotnet restore
+
+    - name: Build
+      run: dotnet build -c Release
+
+    - name: Create Release
+      uses: "marvinpinto/action-automatic-releases@latest"
+      with:
+        repo_token: "${{ secrets.GITHUB_TOKEN }}"
+        prerelease: false

.gitignore

@@ -0,0 +1,37 @@
+*.swp
+*.*~
+project.lock.json
+.DS_Store
+*.pyc
+nupkg/
+
+# Visual Studio Code
+.vscode
+
+# Rider
+.idea
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+msbuild.log
+msbuild.err
+msbuild.wrn
+
+# Visual Studio 2015
+.vs/

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2023-07-21
+
+### Added
+
+- Initial release
+
+[1.0.0]: https://github.com/BrackeysBot/SuggestionBot/releases/tag/v1.0.0

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contribution Guidelines
+
+When contributing to this repository, please first discuss the change you wish to make by contacting one of the bot developers in the Discord server, or by creating a [discussion](https://github.com/oliverbooth/BrackeysBot/discussions) here in this repository.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+1. Update [README.md](README.md) outlining any necessary changes made to the project - do not leave this down to the repository owners.
+2. Do not increase any version numbers. This process is done by us when we feel it necessary to do so.
+3. This repository, and its child repositories, follow Microsoft's [C# coding conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions) and [.NET design guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/). Please adhere to these conventions and guidelines. Pull requests which do not fall in line with the code style will be left open until this is adhered to (and may be closed at any time if we feel the changes will not be agreed upon.)
+
+## Code Style
+Where Microsoft's conventions do not suffice, an .editorconfig is provided in the repository which should integrate with Visual Studio or Rider to automate the process. This .editorconfig should roughly coincide with [StyleCop rules](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/tree/master/documentation), with some minor exceptions.
+
+### Comments
+**Please use comments sparingly!** The use of comments to outline what a particular block of code is doing is usually indicative of the code is not being clear enough in its own right. If you feel that a comment is required to clarify logic, consider refactoring the code to includes having meaningfully named variables and methods so that a comment is redundant.
+
+An example of comment types which would be unacceptable:
+```cs
+foreach (char character in someString) // loop through every char in the string
+{
+    Console.WriteLine(character); // print out each character on a new line
+}
+```
+
+The exception to this is if the comment is explaining the "why" rather than the "what". A comment which outlines the rationale behind a specific solution is acceptable. For example:
+```cs
+for (var index = 0; index < someString.Length; index++) // cheaper than foreach, no allocation of CharEnumerator
+{
+    char character = someString[index];
+    Console.WriteLine(character);
+}
+```
+In such a case, the comment is not explaining what the code does - but why it does it that way, rather than a different way. This type of comment is accepted and encouraged.

Dockerfile

@@ -0,0 +1,18 @@
+FROM mcr.microsoft.com/dotnet/runtime:7.0 AS base
+WORKDIR /app
+
+FROM mcr.microsoft.com/dotnet/sdk:7.0 AS build
+WORKDIR /src
+COPY ["SuggestionBot/SuggestionBot.csproj", "SuggestionBot/"]
+RUN dotnet restore "SuggestionBot/SuggestionBot.csproj"
+COPY . .
+WORKDIR "/src/SuggestionBot"
+RUN dotnet build "SuggestionBot.csproj" -c Release -o /app/build
+
+FROM build AS publish
+RUN dotnet publish "SuggestionBot.csproj" -c Release -o /app/publish
+
+FROM base AS final
+WORKDIR /app
+COPY --from=publish /app/publish .
+ENTRYPOINT ["dotnet", "SuggestionBot.dll"]

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Oliver Booth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+<h1 align="center">SuggestionBot</h1>
+<p align="center"><img src="icon.png" width="128"></p>
+<p align="center"><i>A Discord bot for suggestions.</i></p>
+<p align="center">
+<a href="https://github.com/BrackeysBot/SuggestionBot/releases"><img src="https://img.shields.io/github/v/release/BrackeysBot/SuggestionBot?include_prereleases&style=flat-square"></a>
+<a href="https://github.com/BrackeysBot/SuggestionBot/actions/workflows/dotnet.yml"><img src="https://img.shields.io/github/actions/workflow/status/BrackeysBot/SuggestionBot/dotnet.yml?branch=main&style=flat-square" alt="GitHub Workflow Status" title="GitHub Workflow Status"></a>
+<a href="https://github.com/BrackeysBot/SuggestionBot/issues"><img src="https://img.shields.io/github/issues/BrackeysBot/SuggestionBot?style=flat-square" alt="GitHub Issues" title="GitHub Issues"></a>
+<a href="https://github.com/BrackeysBot/SuggestionBot/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/BrackeysBot/SuggestionBot?style=flat-square" alt="MIT License" title="MIT License"></a>
+</p>
+
+## About
+SuggestionBot is a Discord bot which allows users to submit suggestions.
+
+## Installing and configuring SuggestionBot 
+SuggestionBot runs in a Docker container, and there is a [docker-compose.yml](docker-compose.yml) file which simplifies this process.
+
+### Clone the repository
+To start off, clone the repository into your desired directory:
+```bash
+git clone https://github.com/BrackeysBot/SuggestionBot.git
+```
+Step into the SuggestionBot directory using `cd SuggestionBot`, and continue with the steps below.
+
+### Setting things up
+The bot's token is passed to the container using the `DISCORD_TOKEN` environment variable. Create a file named `.env`, and add the following line:
+```
+DISCORD_TOKEN=your_token_here
+```
+
+Two directories are required to exist for Docker compose to mount as container volumes, `data` and `logs`:
+```bash
+mkdir data
+mkdir logs
+```
+Copy the example `config.example.json` to `data/config.json`, and assign the necessary config keys. Below is breakdown of the config.json layout:
+```json
+{
+  "GUILD_ID": {
+    "logChannel": /* The ID of the log channel */,
+    "suggestionChannel": /* The ID of the channel in which suggestions are posted */,
+    "suggestedColor": /* The default color for suggestions, as a 24-bit RGB integer. Defaults to #FFFF00 */,
+    "implementedColor": /* The color for implemented suggestions, as a 24-bit RGB integer. Defaults to #191970 */,
+    "rejectedColor": /* The color for rejected suggestions, as a 24-bit RGB integer. Defaults to #FF0000 */,
+    "cooldown": /* The cooldown between suggestion posting. Defaults to 3600 */
+  }
+}
+```
+The `logs` directory is used to store logs in a format similar to that of a Minecraft server. `latest.log` will contain the log for the current day and current execution. All past logs are archived.
+
+The `data` directory is used to store persistent state of the bot, such as config values and the infraction database.
+
+### Launch SuggestionBot
+To launch SuggestionBot, simply run the following commands:
+```bash
+sudo docker-compose build
+sudo docker-compose up --detach
+```
+
+## Updating SuggestionBot
+To update SuggestionBot, simply pull the latest changes from the repo and restart the container:
+```bash
+git pull
+sudo docker-compose stop
+sudo docker-compose build
+sudo docker-compose up --detach
+```
+
+## Using SuggestionBot
+For further usage breakdown and explanation of commands, see [USAGE.md](USAGE.md).
+
+## License
+This bot is under the [MIT License](LICENSE.md).
+
+## Disclaimer
+This bot is tailored for use within the [Brackeys Discord server](https://discord.gg/brackeys). While this bot is open source and you are free to use it in your own servers, you accept responsibility for any mishaps which may arise from the use of this software. Use at your own risk.

SuggestionBot.sln

@@ -0,0 +1,21 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SuggestionBot", "SuggestionBot\SuggestionBot.csproj", "{81628814-A6CE-4CD8-9938-726D2A666872}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{33635704-EADC-4619-A034-E90F7F84EA6B}"
+	ProjectSection(SolutionItems) = preProject
+		.dockerignore = .dockerignore
+	EndProjectSection
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{81628814-A6CE-4CD8-9938-726D2A666872}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{81628814-A6CE-4CD8-9938-726D2A666872}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{81628814-A6CE-4CD8-9938-726D2A666872}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{81628814-A6CE-4CD8-9938-726D2A666872}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal