diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 164721b..7c85cf7 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -39,7 +39,6 @@ jobs: uses: docker/build-push-action@v2 with: context: . - file: extras/Dockerfile push: ${{ github.event_name != 'pull_request' }} tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} diff --git a/extras/Bot.png b/Bot.png similarity index 100% rename from extras/Bot.png rename to Bot.png diff --git a/extras/Dockerfile b/Dockerfile similarity index 98% rename from extras/Dockerfile rename to Dockerfile index 76a336d..27de796 100644 --- a/extras/Dockerfile +++ b/Dockerfile @@ -15,7 +15,7 @@ ENV PYTHONDONTWRITEBYTECODE 1 ENV PYTHONUNBUFFERED 1 # Update packages and install needed packages to build our requirements. -RUN apt-get update && apt-get install -y --no-install-recommends build-essential gcc git curl +RUN apt-get update && apt-get install -y --no-install-recommends build-essential gcc curl # Create user so we don't run as root. RUN useradd --create-home botuser diff --git a/README.md b/README.md index 8d1727c..731144e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Discord-reminder-bot

- +

Theme is https://github.com/KillYoy/DiscordNight

@@ -29,16 +29,14 @@ You have two choices, [install directly on your computer](#Install-directly-on-y ### Install directly on your computer - Install latest version of needed software: - - [git](https://git-scm.com/) - - Default installation is fine. - [Python](https://www.python.org/) - You should use the latest version. - You want to add Python to your PATH. - [Poetry](https://python-poetry.org/docs/master/#installation) - - Windows: You have to add `\AppData\Roaming\Python\Scripts` to your PATH for Poetry to work. + - Windows: You have to add `%appdata%\Python\Scripts` to your PATH for Poetry to work. - Download project from GitHub with git or download the [ZIP](https://github.com/TheLovinator1/discord-reminder-bot/archive/refs/heads/master.zip). - If you want to update the bot, you can run `git pull` in the project folder or download the ZIP again. -- Rename .env.example to .env and open it in a text editor (e.g., VSCode, Notepad++, Notepad). (The .env file in the root folder, not the extras folder.) +- Rename .env.example to .env and open it in a text editor (e.g., VSCode, Notepad++, Notepad). - If you can't see the file extension: - Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions. - Windows 11: Click View -> Show -> File name extensions. @@ -46,10 +44,11 @@ You have two choices, [install directly on your computer](#Install-directly-on-y - Windows 10: Shift + right-click in the folder and select `Open PowerShell window here` - Windows 11: Shift + right-click in the folder and Show more options and `Open PowerShell window here` - Install requirements: - - `poetry install` - - (You may have to restart your terminal if it can't find the `poetry` command. Also double check that it's in your PATH.) + - Type `poetry install` into the PowerShell window. Make sure you are + in the repository folder with the [pyproject.toml](pyproject.toml) file. + - You may have to restart your terminal if it can't find the `poetry` command. Also double check that it's in your PATH. - Start the bot: - - `poetry run bot` + - Type `poetry run bot` into the PowerShell window. - You can stop the bot with Ctrl + c. Note: You will need to run `poetry install` again if poetry.lock has been modified. @@ -60,8 +59,7 @@ Note: It can take up to one hour for the slash commands to be visible in the Dis Docker Hub: [thelovinator/discord-reminder-bot](https://hub.docker.com/r/thelovinator/discord-reminder-bot) -- Change directory to the extras folder. -- Rename .env.example to .env and open it in a text editor (e.g., VSCode, Notepad++, Notepad). (The .env file in the extras folder, not in the root folder.) +- Rename .env.example to .env and open it in a text editor (e.g., VSCode, Notepad++, Notepad). - If you can't see the file extension: - Windows 10: Click the View Tab in File Explorer and click the box next to File name extensions. - Windows 11: Click View -> Show -> File name extensions. @@ -78,3 +76,6 @@ Docker Hub: [thelovinator/discord-reminder-bot](https://hub.docker.com/r/thelovi - Email: tlovinator@gmail.com - Discord: TheLovinator#9276 - Steam: [steamcommunity.com/id/TheLovinator/](https://steamcommunity.com/id/TheLovinator/) +- Send an issue: [discord-reminder-bot/issues](https://github.com/TheLovinator1/discord-reminder-bot/issues) +- GitHub Discussions: + [discord-reminder-bot/discussions](https://github.com/TheLovinator1/discord-reminder-bot/discussions) diff --git a/extras/docker-compose.yml b/docker-compose.yml similarity index 100% rename from extras/docker-compose.yml rename to docker-compose.yml diff --git a/extras/.env.example b/extras/.env.example deleted file mode 100644 index a0a7e9c..0000000 --- a/extras/.env.example +++ /dev/null @@ -1,15 +0,0 @@ -# Discord bot token -BOT_TOKEN=JFIiasfjioFIAOJFOIJIOSAF.AFo-7A.akwFakeopfaWPOKawPOFKOAKFPA - -# Timezone -# https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List -# You want to use the TZ databse name. -TIMEZONE=Europe/Stockholm - -# Optional: Change sqlite database location -# SQLITE_LOCATION=/jobs.sqlite # This will be created in the repo root (This is the default if not set) -# SQLITE_LOCATION=/C:\\Users\\Jocke\\Desktop\\db.sqlite3 # Note the double backslashes and the first slash -# SQLITE_LOCATION=//home/lovinator/foo.db # On Linux you will need to use double slashes before the path to get the absolute path - -# Log level, CRITICAL, ERROR, WARNING, INFO, DEBUG -LOG_LEVEL=INFO