Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
<p align="center">
<img src="assets/lucky-mascot/outline-v4-neon.jpeg" alt="Lucky" width="320" />
<img src="assets/lucky-social-preview.png" alt="Lucky — Verified Discord Bot" width="720" />
</p>

<p align="center">
All-in-one Discord bot platform with web dashboard.<br/>
<b>Verified Discord Bot</b> — All-in-one platform with web dashboard.<br/>
Music, moderation, auto-mod, custom commands, feature toggles, and server management.
</p>

[![CI](https://github.com/LucasSantana-Dev/Lucky/actions/workflows/ci.yml/badge.svg)](https://github.com/LucasSantana-Dev/Lucky/actions/workflows/ci.yml)
[![Node.js](https://img.shields.io/badge/Node.js-22.x-green.svg)](https://nodejs.org/)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/)
[![Discord.js](https://img.shields.io/badge/Discord.js-14.25-purple.svg)](https://discord.js.org/)
[![License](https://img.shields.io/badge/License-ISC-yellow.svg)](LICENSE)
[![CI](https://github.com/LucasSantana-Dev/Lucky/actions/workflows/ci.yml/badge.svg)](https://github.com/LucasSantana-Dev/Lucky/actions/workflows/ci.yml)
[![Discord](https://img.shields.io/badge/Discord-Verified_Bot-5865F2?logo=discord&logoColor=white)](https://discord.com/application-directory)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)](CONTRIBUTING.md)
Comment on lines +15 to +16

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify CONTRIBUTING.md exists

# Check if CONTRIBUTING.md exists in the repository root
fd -t f "^CONTRIBUTING.md$"

Repository: LucasSantana-Dev/Lucky

Length of output: 48


🏁 Script executed:

# Search for contributing files with various names
fd -t f -i "contrib" 

# Also check the README to understand context around lines 15-16
head -20 README.md

Repository: LucasSantana-Dev/Lucky

Length of output: 1148


Fix the broken CONTRIBUTING.md link in the PRs Welcome badge.

The PRs Welcome badge on line 16 links to CONTRIBUTING.md, which does not exist in the repository. Either create the file or update the badge to link to an appropriate contribution guidelines resource. Additionally, the Discord badge on line 15 currently links to the general application directory (https://discord.com/application-directory). Consider updating it to link to Lucky's specific Discord app page if available, to improve discoverability.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 15 - 16, The PRs Welcome badge currently links to a
non-existent CONTRIBUTING.md; either add a CONTRIBUTING.md with your
repository's contribution guidelines or update the badge link target from
"CONTRIBUTING.md" to an existing contribution page (e.g., CONTRIBUTING.md in
docs or a GitHub URL); also consider replacing the Discord badge URL
"https://discord.com/application-directory" with the project's specific Discord
invite or app page to improve discoverability (update the markdown badge links
in the README where the two badges are defined).


## Architecture

Expand Down Expand Up @@ -53,14 +55,14 @@ packages/
`ActionPanel` in `packages/frontend/src/components/ui`

### Discord Discovery Media
- Discovery carousel media is stored at
`assets/discord-discovery-media/2026-03/final` and should be referenced from
`main` branch raw URLs for long-term stability:
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/final/01-auth-control.png`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/final/02-server-management.png`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/final/03-feature-suite.png`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/final/04-navigation-loop.gif`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/final/05-live-control-loop.gif`
- **Current (v2)** — branded cards with neon cat mascot + Discord verified badge:
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/v2/01-auth-dashboard.png`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/v2/02-server-management.png`
- `https://raw.githubusercontent.com/LucasSantana-Dev/Lucky/main/assets/discord-discovery-media/2026-03/v2/03-feature-suite.png`
- **Bot banner**: `assets/lucky-bot-banner.png` (600x240)
- **Social preview**: `assets/lucky-social-preview.png` (1280x640)
- **Verified announcement**: `assets/lucky-verified-announcement.png` (1280x640)
- Legacy v1 images kept at `assets/discord-discovery-media/2026-03/final/`

### Latest Release (`v2.6.17`)
- Hardened queue snapshot restore: staleness guard (30-min default),
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/lucky-bot-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/lucky-social-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/lucky-verified-announcement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading