Skip to content

Commit 9b6731e

Browse files
committed
chore: update project references from list_am_bot to listambot
- Renamed all instances of `list_am_bot` to `listambot` across documentation, environment variables, and configuration files for consistency. - Adjusted Docker and Makefile configurations to reflect the new naming convention. - Updated README and contributing guidelines to ensure clarity in project setup and usage.
1 parent 6b951e1 commit 9b6731e

File tree

13 files changed

+105
-105
lines changed

13 files changed

+105
-105
lines changed

.github/VARIABLES_SETUP.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Add in **Variables** tab:
2121

2222
- **`DEPLOY_HOST`** = `your-server.com`
2323
- **`DEPLOY_USER`** = `deploy`
24-
- **`PROJECT_DIR`** = `/opt/list_am_bot`
24+
- **`PROJECT_DIR`** = `/opt/listambot`
2525

2626
### 3. CONFIG Secret Content
2727

@@ -40,12 +40,12 @@ FLARESOLVERR_MAX_TIMEOUT=60000
4040

4141
NODE_ENV=production
4242

43-
POSTGRES_HOST=list_am_bot.postgres
43+
POSTGRES_HOST=listambot.postgres
4444
POSTGRES_PORT=5432
45-
POSTGRES_USERNAME=list_am_bot
45+
POSTGRES_USERNAME=listambot
4646
POSTGRES_PASSWORD=secure_password_here
47-
POSTGRES_NAME=list_am_bot
48-
POSTGRES_BASE_URL=postgresql://list_am_bot:secure_password_here@list_am_bot.postgres:5432/list_am_bot
47+
POSTGRES_NAME=listambot
48+
POSTGRES_BASE_URL=postgresql://listambot:secure_password_here@listambot.postgres:5432/listambot
4949
POSTGRES_TELEGRAF_SCHEMA=public
5050
```
5151

@@ -55,7 +55,7 @@ POSTGRES_TELEGRAF_SCHEMA=public
5555
# 1. Set deployment variables
5656
gh variable set DEPLOY_HOST --body "your-server.com"
5757
gh variable set DEPLOY_USER --body "deploy"
58-
gh variable set PROJECT_DIR --body "/opt/list_am_bot"
58+
gh variable set PROJECT_DIR --body "/opt/listambot"
5959

6060
# 2. Set SSH key
6161
gh secret set DEPLOY_SSH_KEY < ~/.ssh/deploy_key
@@ -66,7 +66,7 @@ gh secret set CONFIG < .env.production
6666
# Or directly (multi-line)
6767
gh secret set CONFIG --body "BOT_TOKEN=xxx
6868
BOT_ENVIRONMENT=production
69-
POSTGRES_HOST=list_am_bot.postgres
69+
POSTGRES_HOST=listambot.postgres
7070
..."
7171
```
7272

@@ -89,12 +89,12 @@ FLARESOLVERR_MAX_TIMEOUT=60000
8989
9090
NODE_ENV=production
9191
92-
POSTGRES_HOST=list_am_bot.postgres
92+
POSTGRES_HOST=listambot.postgres
9393
POSTGRES_PORT=5432
94-
POSTGRES_USERNAME=list_am_bot
94+
POSTGRES_USERNAME=listambot
9595
POSTGRES_PASSWORD=secure_password_here
96-
POSTGRES_NAME=list_am_bot
97-
POSTGRES_BASE_URL=postgresql://list_am_bot:secure_password_here@list_am_bot.postgres:5432/list_am_bot
96+
POSTGRES_NAME=listambot
97+
POSTGRES_BASE_URL=postgresql://listambot:secure_password_here@listambot.postgres:5432/listambot
9898
POSTGRES_TELEGRAF_SCHEMA=public
9999
EOF
100100

.github/workflows/build-and-deploy.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ jobs:
105105
postgres:
106106
image: postgres:14
107107
env:
108-
POSTGRES_USER: list_am_bot
108+
POSTGRES_USER: listambot
109109
POSTGRES_PASSWORD: password
110-
POSTGRES_DB: list_am_bot_test
110+
POSTGRES_DB: listambot_test
111111
options: >-
112112
--health-cmd pg_isready
113113
--health-interval 10s
@@ -133,9 +133,9 @@ jobs:
133133
--network host \
134134
-e POSTGRES_HOST=localhost \
135135
-e POSTGRES_PORT=5432 \
136-
-e POSTGRES_USERNAME=list_am_bot \
136+
-e POSTGRES_USERNAME=listambot \
137137
-e POSTGRES_PASSWORD=password \
138-
-e POSTGRES_NAME=list_am_bot_test \
138+
-e POSTGRES_NAME=listambot_test \
139139
-e BOT_TOKEN=test_token \
140140
-e NODE_ENV=test \
141141
${{ needs.build.outputs.base-image }} \

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ jobs:
7171
postgres:
7272
image: postgres:14
7373
env:
74-
POSTGRES_USER: list_am_bot
74+
POSTGRES_USER: listambot
7575
POSTGRES_PASSWORD: password
76-
POSTGRES_DB: list_am_bot_test
76+
POSTGRES_DB: listambot_test
7777
options: >-
7878
--health-cmd pg_isready
7979
--health-interval 10s
@@ -100,9 +100,9 @@ jobs:
100100
env:
101101
POSTGRES_HOST: localhost
102102
POSTGRES_PORT: 5432
103-
POSTGRES_USERNAME: list_am_bot
103+
POSTGRES_USERNAME: listambot
104104
POSTGRES_PASSWORD: password
105-
POSTGRES_NAME: list_am_bot_test
105+
POSTGRES_NAME: listambot_test
106106
BOT_TOKEN: test_token
107107
NODE_ENV: test
108108

CICD.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -95,12 +95,12 @@ Go to **Secrets** tab and add:
9595

9696
Go to **Variables** tab and add:
9797

98-
| Variable Name | Description | Example |
99-
| ------------- | ------------------------------- | ------------------ |
100-
| `DEPLOY_HOST` | Production server hostname/IP | `your-server.com` |
101-
| `DEPLOY_USER` | SSH username | `deploy` |
102-
| `DEPLOY_PORT` | SSH port (optional, default 22) | `2221` |
103-
| `PROJECT_DIR` | Deployment directory on server | `/opt/list_am_bot` |
98+
| Variable Name | Description | Example |
99+
| ------------- | ------------------------------- | ----------------- |
100+
| `DEPLOY_HOST` | Production server hostname/IP | `your-server.com` |
101+
| `DEPLOY_USER` | SSH username | `deploy` |
102+
| `DEPLOY_PORT` | SSH port (optional, default 22) | `2221` |
103+
| `PROJECT_DIR` | Deployment directory on server | `/opt/listambot` |
104104

105105
#### 3. CONFIG Secret Format
106106

@@ -119,12 +119,12 @@ FLARESOLVERR_MAX_TIMEOUT=60000
119119
120120
NODE_ENV=production
121121
122-
POSTGRES_HOST=list_am_bot.postgres
122+
POSTGRES_HOST=listambot.postgres
123123
POSTGRES_PORT=5432
124-
POSTGRES_USERNAME=list_am_bot
124+
POSTGRES_USERNAME=listambot
125125
POSTGRES_PASSWORD=secure_password_here
126-
POSTGRES_NAME=list_am_bot
127-
POSTGRES_BASE_URL=postgresql://list_am_bot:secure_password_here@list_am_bot.postgres:5432/list_am_bot
126+
POSTGRES_NAME=listambot
127+
POSTGRES_BASE_URL=postgresql://listambot:secure_password_here@listambot.postgres:5432/listambot
128128
POSTGRES_TELEGRAF_SCHEMA=public
129129
```
130130

@@ -185,17 +185,17 @@ If you prefer separate variables instead of single `CONFIG`:
185185
| -------------------------- | --------------------------------- | -------------------------- |
186186
| `DEPLOY_HOST` | Production server hostname/IP | `your-server.com` |
187187
| `DEPLOY_USER` | SSH username | `deploy` |
188-
| `PROJECT_DIR` | Deployment directory on server | `/opt/list_am_bot` |
188+
| `PROJECT_DIR` | Deployment directory on server | `/opt/listambot` |
189189
| `BOT_INCIDENTS_USER_ID` | Admin Telegram user ID for errors | `123456789` |
190190
| `BOT_ENVIRONMENT` | Environment name | `production` |
191191
| `BOT_DOMAIN` | Domain for webhook | `your-domain.com` |
192192
| `BOT_WEBHOOK_URL` | Webhook path | `/telegram-webhook` |
193193
| `FLARESOLVERR_URL` | FlareSolverr service URL | `http://flaresolverr:8191` |
194194
| `FLARESOLVERR_PORT` | FlareSolverr service port | `8191` |
195195
| `NODE_ENV` | Node environment | `production` |
196-
| `POSTGRES_HOST` | PostgreSQL hostname | `list_am_bot.postgres` |
196+
| `POSTGRES_HOST` | PostgreSQL hostname | `listambot.postgres` |
197197
| `POSTGRES_PORT` | PostgreSQL port | `5432` |
198-
| `POSTGRES_NAME` | Database name | `list_am_bot` |
198+
| `POSTGRES_NAME` | Database name | `listambot` |
199199
| `POSTGRES_TELEGRAF_SCHEMA` | Schema for Telegraf sessions | `public` |
200200

201201
</details>
@@ -221,7 +221,7 @@ Images are automatically pushed to `ghcr.io/<username>/list_am_bot/`:
221221
### Make Images Public (Optional)
222222

223223
1. Go to your profile → **Packages**
224-
2. Click on `list_am_bot/base` and `list_am_bot/app`
224+
2. Click on `listambot/base` and `listambot/app`
225225
3. **Package settings → Change visibility → Public**
226226

227227
---
@@ -251,8 +251,8 @@ sudo useradd -m -s /bin/bash deploy
251251
sudo usermod -aG docker deploy
252252
253253
# Create project directory
254-
sudo mkdir -p /opt/list_am_bot
255-
sudo chown deploy:deploy /opt/list_am_bot
254+
sudo mkdir -p /opt/listambot
255+
sudo chown deploy:deploy /opt/listambot
256256
257257
# Create Docker network (for external network in docker-compose)
258258
docker network create listambot_network
@@ -292,7 +292,7 @@ ssh -p 2221 deploy@your-server
292292
# ssh deploy@your-server
293293
294294
# Navigate to project directory
295-
cd /opt/list_am_bot
295+
cd /opt/listambot
296296
297297
# Create Docker network if it doesn't exist
298298
docker network create listambot_network || true
@@ -330,20 +330,20 @@ ssh -p 2221 deploy@your-server
330330
docker ps
331331
332332
# View logs
333-
docker logs -f list_am_bot.core
333+
docker logs -f listambot.core
334334
335335
# Check service health
336-
docker exec list_am_bot.core curl -f http://localhost:3000/health || echo "Service down"
336+
docker exec listambot.core curl -f http://localhost:3000/health || echo "Service down"
337337
```
338338

339339
### Rollback Deployment
340340

341341
```bash
342342
# SSH to server
343-
cd /opt/list_am_bot
343+
cd /opt/listambot
344344
345345
# Check available images
346-
docker images | grep list_am_bot
346+
docker images | grep listambot
347347
348348
# Update docker-compose.yml with previous version
349349
sed -i 's/:main/:previous-tag/g' docker-compose.yml
@@ -445,7 +445,7 @@ docker run --rm \
445445
sh -c 'npm test'
446446
447447
# Check PostgreSQL is accessible
448-
docker run --rm --network host postgres:14 psql -h localhost -U list_am_bot -d list_am_bot_test -c "SELECT 1"
448+
docker run --rm --network host postgres:14 psql -h localhost -U listambot -d listambot_test -c "SELECT 1"
449449
```
450450

451451
---

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Unsure where to begin? Look for issues labeled:
7878
```bash
7979
# Fork the repository on GitHub, then:
8080
git clone https://github.com/zombiQWERTY/list_am_bot.git
81-
cd list_am_bot
81+
cd listambot
8282
```
8383

8484
### 2. Set Up Environment
@@ -98,7 +98,7 @@ make up
9898

9999
```bash
100100
# Access container
101-
docker exec -it list_am_bot.core bash
101+
docker exec -it listambot.core bash
102102

103103
# Create schemas
104104
psql $POSTGRES_BASE_URL -c "CREATE SCHEMA IF NOT EXISTS core;"
@@ -275,7 +275,7 @@ No functional changes, just better separation of concerns.
275275

276276
```bash
277277
# Inside container
278-
docker exec -it list_am_bot.core npm run build
278+
docker exec -it listambot.core npm run build
279279

280280
# Or locally
281281
npm run build
@@ -285,7 +285,7 @@ No functional changes, just better separation of concerns.
285285

286286
```bash
287287
# Inside container
288-
docker exec -it list_am_bot.core npm run lint
288+
docker exec -it listambot.core npm run lint
289289

290290
# Or locally
291291
npm run lint
@@ -301,7 +301,7 @@ No functional changes, just better separation of concerns.
301301

302302
```bash
303303
# Inside container
304-
docker exec -it list_am_bot.core npm run test
304+
docker exec -it listambot.core npm run test
305305

306306
# Or locally
307307
npm run test
@@ -391,8 +391,8 @@ Add screenshots here
391391

392392
## 🆘 Getting Help
393393

394-
- **Questions?** Open a [discussion](https://github.com/yourusername/list_am_bot/discussions)
395-
- **Bugs?** Open an [issue](https://github.com/yourusername/list_am_bot/issues)
394+
- **Questions?** Open a [discussion](https://github.com/zombiQWERTY/listambot/discussions)
395+
- **Bugs?** Open an [issue](https://github.com/zombiQWERTY/listambot/issues)
396396
- **Setup issues?** Check [QUICK_START.md](QUICK_START.md) and [Troubleshooting](README.md#-troubleshooting)
397397

398398
### Development Commands Quick Reference

0 commit comments

Comments
 (0)