{"id":25435470,"url":"https://github.com/csivitu/bl0b","last_synced_at":"2026-04-30T14:32:45.610Z","repository":{"id":46601521,"uuid":"312051220","full_name":"csivitu/bl0b","owner":"csivitu","description":"A Discord bot to notify about upcoming CTFs, scores, ranks, and more.","archived":false,"fork":false,"pushed_at":"2021-10-04T11:17:27.000Z","size":143,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-17T07:34:13.456Z","etag":null,"topics":["discord","discord-bot","discord-go","go","go-sql","golang","golang-application","hacktoberfest","sql","sqlx"],"latest_commit_sha":null,"homepage":"","language":"Go","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/csivitu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-11T18:09:22.000Z","updated_at":"2022-09-19T09:06:47.000Z","dependencies_parsed_at":"2022-09-23T04:41:42.965Z","dependency_job_id":null,"html_url":"https://github.com/csivitu/bl0b","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"csivitu/Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csivitu%2Fbl0b","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csivitu%2Fbl0b/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csivitu%2Fbl0b/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csivitu%2Fbl0b/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csivitu","download_url":"https://codeload.github.com/csivitu/bl0b/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254041,"owners_count":22039792,"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":["discord","discord-bot","discord-go","go","go-sql","golang","golang-application","hacktoberfest","sql","sqlx"],"created_at":"2025-02-17T07:30:04.851Z","updated_at":"2026-04-30T14:32:40.573Z","avatar_url":"https://github.com/csivitu.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![csivit][csivitu-shield]][csivitu-url]\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n[![Issues][issues-shield]][issues-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/csivitu/bl0b\"\u003e\n    \u003cimg src=\"https://csivit.com/images/favicon.png\" alt=\"Logo\" width=\"80\"\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"https://github.com/csivitu/bl0b\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/csivitu/bl0b/master/assets/images/bl0b.png\" alt=\"Logo\" width=\"80\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003ebl0b\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A discord bot to notify you about upcoming CTFs from CTFtime, and more.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/csivitu/bl0b\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/csivitu/bl0b\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/csivitu/bl0b/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/csivitu/bl0b/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#about-the-project)\n  * [Built With](#built-with)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n* [Usage](#usage)\n* [Roadmap](#roadmap)\n* [Contributing](#contributing)\n* [License](#license)\n* [Contributors](#contributors-)\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n![bl0b screenshot](./assets/images/bl0b-sample.png)\n\n\n\n### Built With\n\n* [golang](https://golang.org)\n* [discordgo](https://github.com/bwmarrin/discordgo)\n* [sqlx](https://github.com/jmoiron/sqlx)\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nThe recommended way of deploying `bl0b` on your server is using `docker`.\n\n### Prerequisites\n\n* docker\n* docker-compose\n\nYou can install docker and docker-compose with the help of the following links.\n\n- docker: https://docs.docker.com/engine/install/\n- docker-compose: https://docs.docker.com/compose/install/\n\n### Installation\n\nAssuming you have already obtained a bot token from `Discord`, you need to follow these steps to get the bot up and running.\n \n1. Clone the repo and `cd` into it.\n```sh\ngit clone https://github.com/csivitu/bl0b.git\ncd bl0b\n```\n\n2. Create a file called `.env.prod` to store all the secrets (environment variables). Here's a sample:\n\n```sh\nDG_TOKEN=Bot Asf1fa94jfn1n3nfeqafn4231.saf1F3.Asff_dadfVdaw1354f_d-0NsMLSofpg\nDB_USER=root\nDB_PASS=root\nDB_IP=db\nDB_PORT=3306\n```\n\nThe configuration above will work directly if you replace the token `Asf1fa94jfn1n3nfeqafn4231.saf1F3.Asff_dadfVdaw1354f_d-0NsMLSofpg` with your `Discord` bot token.\n\nHere are some things to note:\n* The DG_TOKEN _must_ have the prefix `Bot `. If the token you got from `Discord` does not begin with `Bot `, prepend it to the string as show in the sample above.\n* If you're using `docker-compose`, make sure the `DB_IP` is `db`, i.e, the name of the service responsible for running the `mysql` database.\n* The `DB_USER` must have permission to create a database, which is why it's easiest to set it to `root` if you're using the `docker-compose` way. If not, it is **not** recommended to set `DB_USER` to root, instead, create a `database` called `bl0b` and grant all permissions on that database to the `DB_USER`.\n\n3. Run `bl0b` using `docker-compose`.\n```sh\ndocker-compose up -d --build\n```\n\nCongratulations! You have `bl0b` up and running.\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nOnce you add `bl0b` to your server, you can request the help menu using the following command:\n\n```sh\nbl0b help\n```\n\nAlternatively, you can tag the bot or send it a DM.\n\n```sh\n# Tagging the bot\n@bl0b help\n\n# DM-ing the bot\nhelp\n```\n\nThe help menu lists all the commands you can use!\n\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/csivitu/bl0b/issues) for a list of proposed features (and known issues).\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nYou are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.\n\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue\n[csivitu-url]: https://csivit.com\n[issues-shield]: https://img.shields.io/github/issues/csivitu/bl0b.svg?style=flat-square\n[issues-url]: https://github.com/csivitu/bl0b/issues\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/roerohan\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/42958812?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRohan Mukherjee\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/csivitu/bl0b/commits?author=roerohan\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/csivitu/bl0b/commits?author=roerohan\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsivitu%2Fbl0b","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsivitu%2Fbl0b","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsivitu%2Fbl0b/lists"}