{"id":30028179,"url":"https://github.com/tyecode-bots/role-reactor-website","last_synced_at":"2025-08-06T15:02:17.756Z","repository":{"id":307795821,"uuid":"1026752232","full_name":"tyecode-bots/role-reactor-website","owner":"tyecode-bots","description":"A modern documentation website for the Role Reactor Discord bot, built with Next.js 15 and Fumadocs.","archived":false,"fork":false,"pushed_at":"2025-08-02T08:43:58.000Z","size":1558,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-02T09:57:50.143Z","etag":null,"topics":["discord-bot","documentation","fumadocs","mdx","nextjs","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tyecode-bots.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-26T14:39:48.000Z","updated_at":"2025-08-02T08:44:01.000Z","dependencies_parsed_at":"2025-08-02T10:08:05.101Z","dependency_job_id":null,"html_url":"https://github.com/tyecode-bots/role-reactor-website","commit_stats":null,"previous_names":["tyecode-bots/role-reactor-website"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/tyecode-bots/role-reactor-website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyecode-bots%2Frole-reactor-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyecode-bots%2Frole-reactor-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyecode-bots%2Frole-reactor-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyecode-bots%2Frole-reactor-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tyecode-bots","download_url":"https://codeload.github.com/tyecode-bots/role-reactor-website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tyecode-bots%2Frole-reactor-website/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269100789,"owners_count":24359807,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord-bot","documentation","fumadocs","mdx","nextjs","tailwindcss","typescript"],"created_at":"2025-08-06T15:00:48.773Z","updated_at":"2025-08-06T15:02:17.721Z","avatar_url":"https://github.com/tyecode-bots.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"public/logo.png\" alt=\"Role Reactor Logo\" width=\"120\" height=\"auto\" /\u003e\n\n# Role Reactor Documentation\n\n**Official documentation website for the Role Reactor Discord bot**  \n_Streamline your Discord server role management with powerful reaction-based role assignment_\n\n[![Website](https://img.shields.io/badge/Website-rolereactor.app-blue?style=for-the-badge\u0026logo=discord)](https://rolereactor.app)\n[![Documentation](https://img.shields.io/badge/Documentation-Docs-blue?style=for-the-badge\u0026logo=book)](https://rolereactor.app/docs)\n[![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)](LICENSE)\n[![Next.js](https://img.shields.io/badge/Next.js-15-black?style=for-the-badge\u0026logo=next.js)](https://nextjs.org)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue?style=for-the-badge\u0026logo=typescript)](https://typescriptlang.org)\n\n[![OpenGraph Preview](public/og.png)](https://rolereactor.app)\n\n\u003c/div\u003e\n\n---\n\n## 🚀 Features\n\n\u003cdiv align=\"center\"\u003e\n\n| Feature                            | Description                                                  |\n| ---------------------------------- | ------------------------------------------------------------ |\n| 📚 **Comprehensive Documentation** | Complete guides for bot setup, commands, and troubleshooting |\n| 🔍 **Smart Search**                | Fast content search across all documentation pages           |\n| 📱 **Responsive Design**           | Optimized for desktop, tablet, and mobile devices            |\n| ⚡ **Performance Optimized**       | Built with Next.js 15 for blazing fast loading               |\n| 🎨 **Modern UI**                   | Clean, accessible design with Tailwind CSS                   |\n| 🔧 **Developer Friendly**          | TypeScript, ESLint, and comprehensive testing                |\n\n\u003c/div\u003e\n\n## 🛠️ Tech Stack\n\n\u003cdiv align=\"center\"\u003e\n\n![Next.js](https://img.shields.io/badge/Next.js-15-black?style=flat-square\u0026logo=next.js)\n![React](https://img.shields.io/badge/React-19-blue?style=flat-square\u0026logo=react)\n![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue?style=flat-square\u0026logo=typescript)\n![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-4.1-38B2AC?style=flat-square\u0026logo=tailwind-css)\n![Fumadocs](https://img.shields.io/badge/Fumadocs-15.6.5-000000?style=flat-square)\n![Jest](https://img.shields.io/badge/Jest-29.7-C21325?style=flat-square\u0026logo=jest)\n\n\u003c/div\u003e\n\n### Core Technologies\n\n- **Framework**: [Next.js 15](https://nextjs.org/) with App Router\n- **Documentation**: [Fumadocs](https://fumadocs.vercel.app/) with MDX support\n- **Styling**: [Tailwind CSS 4.1](https://tailwindcss.com/)\n- **Language**: [TypeScript 5.8](https://typescriptlang.org/)\n- **Testing**: [Jest](https://jestjs.io/) with React Testing Library\n- **Package Manager**: [pnpm](https://pnpm.io/)\n\n## 📦 Quick Start\n\n### Prerequisites\n\n- Node.js 18+\n- pnpm (recommended) or npm\n\n### Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/tyecode-bots/role-reactor-website.git\ncd role-reactor-website\n\n# Install dependencies\npnpm install\n\n# Start development server\npnpm dev\n```\n\nVisit [http://localhost:3000](http://localhost:3000) to view the documentation.\n\n## 📁 Project Structure\n\n```\nrole-reactor-website/\n├── 📄 content/docs/           # Documentation content (MDX)\n│   ├── 📖 commands/          # Bot command documentation\n│   ├── 🎯 examples/          # Real-world use cases\n│   ├── 🚀 getting-started/   # Setup and installation guides\n│   ├── 🔧 troubleshooting/   # FAQ and common issues\n│   └── 📝 changelog/         # Version history\n├── 🎨 src/\n│   ├── 📱 app/              # Next.js App Router pages\n│   ├── 🧩 components/       # Reusable React components\n│   ├── 📊 constants/        # Application constants\n│   └── 🛠️ lib/             # Utility functions\n└── 🖼️ public/              # Static assets (logos, icons)\n```\n\n## 🚀 Available Scripts\n\n\u003cdiv align=\"center\"\u003e\n\n| Command              | Description                              |\n| -------------------- | ---------------------------------------- |\n| `pnpm dev`           | Start development server with hot reload |\n| `pnpm build`         | Build for production                     |\n| `pnpm start`         | Start production server                  |\n| `pnpm lint`          | Run ESLint for code quality              |\n| `pnpm type-check`    | Run TypeScript type checking             |\n| `pnpm test`          | Run Jest tests                           |\n| `pnpm test:watch`    | Run tests in watch mode                  |\n| `pnpm test:coverage` | Generate test coverage report            |\n\n\u003c/div\u003e\n\n## 📚 Documentation Sections\n\n### 🚀 Getting Started\n\n- **Introduction**: Overview of Role Reactor bot capabilities\n- **Setup**: Step-by-step installation and configuration\n- **Adding Bot**: How to add the bot to your Discord server\n- **First Steps**: Initial setup and basic configuration\n\n### 🎮 Commands\n\n- **General Commands**: Help, invite, support commands\n- **Role Management**: Setup, list, update, delete reaction roles\n- **Temporary Roles**: Assign and manage temporary roles\n\n### 🎯 Examples\n\n- **Community Server**: Managing community roles and permissions\n- **Educational Server**: Academic role management and organization\n- **Gaming Server**: Gaming community setup and role hierarchy\n\n### 🔧 Troubleshooting\n\n- **Common Issues**: Frequently encountered problems and solutions\n- **FAQ**: Frequently asked questions and answers\n- **Support**: Getting help and community support\n\n## 🔧 Development Guidelines\n\n### Commit Convention\n\nThis project enforces [Conventional Commits](https://www.conventionalcommits.org/) using Husky and Commitlint.\n\n#### Commit Message Format\n\n```\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n\n[optional body]\n\n[optional footer(s)]\n```\n\n#### Allowed Types\n\n| Type       | Description                                         |\n| ---------- | --------------------------------------------------- |\n| `feat`     | A new feature                                       |\n| `fix`      | A bug fix                                           |\n| `docs`     | Documentation only changes                          |\n| `style`    | Changes that do not affect code meaning             |\n| `refactor` | Code change that neither fixes bug nor adds feature |\n| `perf`     | Code change that improves performance               |\n| `test`     | Adding missing tests or correcting existing tests   |\n| `build`    | Changes that affect build system or dependencies    |\n| `ci`       | Changes to CI configuration files and scripts       |\n| `chore`    | Other changes that don't modify src or test files   |\n| `revert`   | Reverts a previous commit                           |\n\n#### Examples\n\n```bash\nfeat: add privacy policy page\nfix: resolve mobile navigation bug\ndocs: update installation instructions\nstyle: improve button hover animations\nrefactor: extract common utility functions\n```\n\n### Pre-commit Hooks\n\n- ✅ ESLint checks for code quality\n- ✅ TypeScript type checking\n- ✅ Commit message validation\n\n## 🌐 Deployment\n\n### Vercel (Recommended)\n\n1. Connect your GitHub repository to [Vercel](https://vercel.com)\n2. Vercel automatically detects Next.js and builds the project\n3. Deploy with zero configuration\n\n### Environment Variables\n\n```env\nNEXT_PUBLIC_SITE_URL=https://rolereactor.app\n```\n\n## 🤝 Contributing\n\nWe welcome contributions! Please follow these steps:\n\n1. **Fork** the repository\n2. **Create** a feature branch: `git checkout -b feature/amazing-feature`\n3. **Make** your changes following the commit convention\n4. **Test** your changes: `pnpm test`\n5. **Push** to the branch: `git push origin feature/amazing-feature`\n6. **Open** a Pull Request\n\n### Development Setup\n\n```bash\n# Install dependencies\npnpm install\n\n# Run tests\npnpm test\n\n# Run linting\npnpm lint\n\n# Type checking\npnpm type-check\n```\n\n## 📖 Learn More\n\n- [📚 Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API\n- [📖 Fumadocs](https://fumadocs.vercel.app) - Learn about the Fumadocs documentation framework\n- [🤖 Role Reactor Bot](https://github.com/tyecode-bots/role-reactor-bot) - The Discord bot this website documents\n- [🎨 Tailwind CSS](https://tailwindcss.com/docs) - Utility-first CSS framework\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**Made with ❤️ by [tyecode](https://github.com/tyecode)**\n\n[![Website](https://img.shields.io/badge/Website-rolereactor.app-blue?style=flat-square)](https://rolereactor.app)\n[![Documentation](https://img.shields.io/badge/Documentation-Docs-blue?style=flat-square)](https://rolereactor.app/docs)\n[![GitHub](https://img.shields.io/badge/GitHub-Repository-black?style=flat-square\u0026logo=github)](https://github.com/tyecode-bots/role-reactor-website)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyecode-bots%2Frole-reactor-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftyecode-bots%2Frole-reactor-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftyecode-bots%2Frole-reactor-website/lists"}