Remove extras folder and make README more verbose
This commit is contained in:
1
.github/workflows/docker-publish.yml
vendored
1
.github/workflows/docker-publish.yml
vendored
@ -39,7 +39,6 @@ jobs:
|
|||||||
uses: docker/build-push-action@v2
|
uses: docker/build-push-action@v2
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
file: extras/Dockerfile
|
|
||||||
push: ${{ github.event_name != 'pull_request' }}
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 31 KiB |
@ -15,7 +15,7 @@ ENV PYTHONDONTWRITEBYTECODE 1
|
|||||||
ENV PYTHONUNBUFFERED 1
|
ENV PYTHONUNBUFFERED 1
|
||||||
|
|
||||||
# Update packages and install needed packages to build our requirements.
|
# 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.
|
# Create user so we don't run as root.
|
||||||
RUN useradd --create-home botuser
|
RUN useradd --create-home botuser
|
21
README.md
21
README.md
@ -1,7 +1,7 @@
|
|||||||
# Discord-reminder-bot
|
# Discord-reminder-bot
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="extras/Bot.png" title="/remind add message_reason: Remember to feed the cat! message_date: 2 November 2025 14:00 CET"/>
|
<img src="Bot.png" title="/remind add message_reason: Remember to feed the cat! message_date: 2 November 2025 14:00 CET"/>
|
||||||
</p>
|
</p>
|
||||||
<p align="center"><sup>Theme is https://github.com/KillYoy/DiscordNight<sup></p>
|
<p align="center"><sup>Theme is https://github.com/KillYoy/DiscordNight<sup></p>
|
||||||
|
|
||||||
@ -29,16 +29,14 @@ You have two choices, [install directly on your computer](#Install-directly-on-y
|
|||||||
### Install directly on your computer
|
### Install directly on your computer
|
||||||
|
|
||||||
- Install latest version of needed software:
|
- Install latest version of needed software:
|
||||||
- [git](https://git-scm.com/)
|
|
||||||
- Default installation is fine.
|
|
||||||
- [Python](https://www.python.org/)
|
- [Python](https://www.python.org/)
|
||||||
- You should use the latest version.
|
- You should use the latest version.
|
||||||
- You want to add Python to your PATH.
|
- You want to add Python to your PATH.
|
||||||
- [Poetry](https://python-poetry.org/docs/master/#installation)
|
- [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).
|
- 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.
|
- 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:
|
- 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 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.
|
- 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: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
|
- Windows 10: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and select `Open PowerShell window here`
|
||||||
- Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options and `Open PowerShell window here`
|
- Windows 11: <kbd>Shift</kbd> + <kbd>right-click</kbd> in the folder and Show more options and `Open PowerShell window here`
|
||||||
- Install requirements:
|
- Install requirements:
|
||||||
- `poetry install`
|
- Type `poetry install` into the PowerShell window. Make sure you are
|
||||||
- (You may have to restart your terminal if it can't find the `poetry` command. Also double check that it's in your PATH.)
|
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:
|
- Start the bot:
|
||||||
- `poetry run bot`
|
- Type `poetry run bot` into the PowerShell window.
|
||||||
- You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.
|
- You can stop the bot with <kbd>Ctrl</kbd> + <kbd>c</kbd>.
|
||||||
|
|
||||||
Note: You will need to run `poetry install` again if poetry.lock has been modified.
|
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)
|
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).
|
||||||
- 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.)
|
|
||||||
- If you can't see the file extension:
|
- 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 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.
|
- 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
|
- Email: tlovinator@gmail.com
|
||||||
- Discord: TheLovinator#9276
|
- Discord: TheLovinator#9276
|
||||||
- Steam: [steamcommunity.com/id/TheLovinator/](https://steamcommunity.com/id/TheLovinator/)
|
- 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)
|
||||||
|
@ -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
|
|
Reference in New Issue
Block a user