Skip to content

Commit c721e00

Browse files
DOCS: create README with beginner guide
Added detailed setup instructions and project overview.
1 parent 1206d56 commit c721e00

1 file changed

Lines changed: 159 additions & 0 deletions

File tree

README.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,161 @@
11
# discord-meme-bot
22
A Discord meme bot for servers that are too lazy to post memes every week.
3+
No server. No hosting. Fully automated.
4+
5+
---
6+
7+
## What is this?
8+
9+
This project automatically sends memes to a Discord channel using a secure webhook system.
10+
11+
Once set up, it runs completely in the background via GitHub Actions.
12+
13+
---
14+
15+
## Quick Start (3 Steps)
16+
17+
### 1. Clone the repository
18+
19+
git clone https://github.com/ErkanSoftwareDeveloper/discord-meme-bot.git
20+
cd discord-meme-bot
21+
22+
---
23+
24+
### 2. Install dependencies
25+
26+
pip install -r requirements.txt
27+
28+
---
29+
30+
### 3. Add Discord webhook (IMPORTANT)
31+
32+
You will NOT put the webhook in the code.
33+
34+
Instead, you will add it to GitHub Secrets.
35+
36+
---
37+
38+
## Create Discord Webhook
39+
40+
In Discord:
41+
42+
1. Open your server
43+
2. Go to the channel where memes should be posted
44+
3. Click "Edit Channel"
45+
4. Go to "Integrations"
46+
5. Open "Webhooks"
47+
6. Click "New Webhook"
48+
7. Copy the Webhook URL
49+
50+
Keep this URL private. Treat it like a password.
51+
52+
---
53+
54+
## GitHub Secrets Setup
55+
56+
Go to your repository:
57+
58+
Settings → Secrets and variables → Actions → New repository secret
59+
60+
Add:
61+
62+
Name:
63+
DISCORD_WEBHOOK_URL
64+
65+
Value:
66+
Your Discord webhook URL
67+
68+
IMPORTANT:
69+
- Do NOT put this in code
70+
- Do NOT commit `.env`
71+
- Only use GitHub Secrets
72+
73+
---
74+
75+
## How it runs
76+
77+
- GitHub Actions runs the bot automatically
78+
- Python script executes
79+
- Meme is sent to Discord
80+
- Process finishes
81+
82+
You can also run it manually from the GitHub Actions tab.
83+
84+
---
85+
86+
## GitHub Actions
87+
88+
The bot runs on schedule using GitHub Actions.
89+
90+
You can:
91+
- Run it daily or weekly
92+
- Trigger it manually
93+
- Let it run automatically in the cloud
94+
95+
No hosting required.
96+
97+
---
98+
99+
## Project Structure
100+
101+
discord-meme-bot/
102+
├── main.py
103+
├── requirements.txt
104+
├── .github/workflows/
105+
└── README.md
106+
107+
---
108+
109+
## Security Rules (IMPORTANT)
110+
111+
- Webhook URL = password
112+
- Never share it
113+
- Never commit `.env`
114+
- If leaked, delete webhook and create a new one
115+
- Always use GitHub Secrets
116+
117+
---
118+
119+
## Common mistakes
120+
121+
If something doesn’t work, check:
122+
123+
- Secret name is exactly: DISCORD_WEBHOOK_URL
124+
- Workflow file exists in `.github/workflows/`
125+
- Dependencies installed
126+
- Webhook URL is valid
127+
- You did NOT hardcode secrets anywhere
128+
129+
---
130+
131+
## Why GitHub Actions?
132+
133+
- No server needed
134+
- Free automation
135+
- Reliable scheduling
136+
- Works 24/7 in the cloud
137+
138+
---
139+
140+
## Summary
141+
142+
To set up:
143+
144+
1. Clone repo
145+
2. Install dependencies
146+
3. Add webhook to GitHub Secrets
147+
4. Run Actions
148+
149+
Done. It works automatically.
150+
151+
---
152+
153+
## Screenshot
154+
155+
<img width="663" height="349" alt="screenshot_discord" src="https://github.com/user-attachments/assets/f2cd1755-1bd7-4098-933a-3a0c1b040cfd" />
156+
157+
---
158+
159+
## License
160+
161+
MIT License

0 commit comments

Comments
 (0)