{"id":27653584,"url":"https://github.com/steph-lion/discord-botstrap","last_synced_at":"2025-04-24T05:04:26.510Z","repository":{"id":287078222,"uuid":"963515931","full_name":"steph-lion/discord-botstrap","owner":"steph-lion","description":"This is a full Typescript template for creating a Discord bot. The codebase uses the common and best practices for linting, formatting and design patterns.","archived":false,"fork":false,"pushed_at":"2025-04-23T12:15:55.000Z","size":888,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-23T12:20:26.024Z","etag":null,"topics":["design-patterns","discord","discord-js","docker","eslint","prettier","template","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/steph-lion.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}},"created_at":"2025-04-09T19:54:12.000Z","updated_at":"2025-04-23T12:14:34.000Z","dependencies_parsed_at":"2025-04-09T21:46:27.326Z","dependency_job_id":null,"html_url":"https://github.com/steph-lion/discord-botstrap","commit_stats":null,"previous_names":["steph-lion/discord-botstrap"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steph-lion%2Fdiscord-botstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steph-lion%2Fdiscord-botstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steph-lion%2Fdiscord-botstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steph-lion%2Fdiscord-botstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steph-lion","download_url":"https://codeload.github.com/steph-lion/discord-botstrap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250566453,"owners_count":21451230,"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","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":["design-patterns","discord","discord-js","docker","eslint","prettier","template","typescript"],"created_at":"2025-04-24T05:02:03.566Z","updated_at":"2025-04-24T05:04:26.497Z","avatar_url":"https://github.com/steph-lion.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Discord Botstrap\n\n![Botstrap Logo](.github/images/botstrap.png)\n\n\u003cdiv align=\"center\"\u003e\n\n![Build Status](https://github.com/steph-lion/discord-botstrap/actions/workflows/ci.yml/badge.svg) ![Test Coverage](https://codecov.io/gh/steph-lion/discord-botstrap/branch/master/graph/badge.svg) ![Discord.js Version](https://img.shields.io/npm/v/discord.js?label=discord.js) ![Node.js Version](https://img.shields.io/badge/Node.js-%3E%3D18-339933?logo=nodedotjs)\n\n\u003c/div\u003e\n\n**discord-botstrap** is a TypeScript template project designed to serve as a launchpad for a customizable and scalable bot. It removes all scaffolding concerns and implements best coding practices. It contains a modular structure for commands and events, making it easy to add new features and maintain the codebase.\nThis template is built on top of [discord.js](https://discord.js.org/) and uses TypeScript for type safety and better development experience. It also includes ESLint and Prettier for code quality and formatting.\n\n## Key Features\n\n- **TypeScript**: Advanced typing for more robust code.\n- **ESLint and Prettier**: Ensures consistent and high-quality code style.\n- **Docker Support**: Easy and portable execution via Docker containers.\n- **Testing**: Includes unit tests with [Jest](https://jestjs.io/) for reliable code.\n- **GitHub Actions**: Automated workflows for linting, testing, and building to ensure code quality and reliability for each PR and commit.\n\n## Requirements\n\n- Node.js \u003e= 18\n- pnpm (Package Manager)\n- Docker (optional, for containerized execution)\n\n## Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/steph-lion/discord-botstrap.git\n   cd discord-botstrap\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   pnpm install\n   ```\n\n3. Configure environment variables:\n   Create a `.env` file in the root of the project and add the following variables:\n   ```env\n   DISCORD_TOKEN=\u003cyour_discord_token\u003e\n   DISCORD_CLIENT_ID=\u003cyour_client_id\u003e\n   DISCORD_GUILD_ID=\u003cyour_guild_id\u003e\n   ```\n\n## Running Locally\n\n1. Build the project:\n\n   ```bash\n   pnpm build\n   ```\n\n2. Start the bot:\n\n   ```bash\n   pnpm start\n   ```\n\n3. For development, use the command:\n   ```bash\n   pnpm dev\n   ```\n\n## Running with Docker\n\n1. Build the Docker image:\n\n   ```bash\n   docker-compose build\n   ```\n\n2. Start the container:\n\n   ```bash\n   docker-compose up\n   ```\n\n3. To stop the container:\n   ```bash\n   docker-compose down\n   ```\n\n## Linting and Formatting\n\nThis project uses **ESLint** and **Prettier** to maintain consistent code style:\n\n- To lint the code with ESLint:\n\n  ```bash\n  pnpm lint\n  ```\n\n- To format the code with Prettier:\n  ```bash\n  pnpm format\n  ```\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute to this project, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix:\n   ```bash\n   git checkout -b feature/your-feature-name\n   ```\n3. Make your changes and commit them:\n   ```bash\n   git commit -m \"Add your message here\"\n   ```\n4. Push your branch:\n   ```bash\n   git push origin feature/your-feature-name\n   ```\n5. Open a pull request and describe your changes.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteph-lion%2Fdiscord-botstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteph-lion%2Fdiscord-botstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteph-lion%2Fdiscord-botstrap/lists"}