{"id":14974791,"url":"https://github.com/jremes-foss/beectf","last_synced_at":"2025-07-07T17:35:26.404Z","repository":{"id":38288954,"uuid":"184812933","full_name":"jremes-foss/BeeCTF","owner":"jremes-foss","description":"Laravel-Based Community CTF Platform","archived":false,"fork":false,"pushed_at":"2024-11-13T00:08:07.000Z","size":2406,"stargazers_count":15,"open_issues_count":10,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T04:41:22.316Z","etag":null,"topics":["ctf","ctf-challenges","ctf-events","ctf-platform","docker","hacktoberfest","laravel","laravel-application","laravel-framework","laravel6","php","php7"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/jremes-foss.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-03T19:54:53.000Z","updated_at":"2024-11-13T06:49:38.000Z","dependencies_parsed_at":"2024-06-29T01:37:33.578Z","dependency_job_id":"e7c72b5a-442b-4e1a-bd78-5f4e9bd33263","html_url":"https://github.com/jremes-foss/BeeCTF","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jremes-foss%2FBeeCTF","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jremes-foss%2FBeeCTF/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jremes-foss%2FBeeCTF/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jremes-foss%2FBeeCTF/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jremes-foss","download_url":"https://codeload.github.com/jremes-foss/BeeCTF/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238472043,"owners_count":19478150,"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":["ctf","ctf-challenges","ctf-events","ctf-platform","docker","hacktoberfest","laravel","laravel-application","laravel-framework","laravel6","php","php7"],"created_at":"2024-09-24T13:51:05.269Z","updated_at":"2025-02-12T12:31:24.077Z","avatar_url":"https://github.com/jremes-foss.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BeeCTF\n\nLaravel-Based Community CTF Platform.\n\n## Introduction\nBeeCTF is a [CTF](https://en.wikipedia.org/wiki/Wargame_(hacking)) platform intended for small and local community groups who want to host their own CTF competitions. A small size and light weight makes BeeCTF a good platform to be hosted even in a small computer such as [Raspberry Pi](https://www.raspberrypi.org/) effectively. Built on [Laravel 8.0](https://laravel.com/), BeeCTF is easy to install and run even if your hardware is more limited.\n\n## Requirements\nBeeCTF requires PHP version 8.2.0 with [composer](https://getcomposer.org/) and NodeJS.\n\n## Installation\n\n### Local\nInstallation of BeeCTF in traditional way is easy:\n\n```bash\ngit clone https://github.com/Newman101/BeeCTF\ncomposer install\ncomposer update\nphp artisan key:generate\nphp artisan user:create-admin\n```\n\nIn order to build NPM dependencies for development purposes, please run:\n\n```bash\nnpm install\nnpm run dev\n```\n\nPlease note: `pngquant` dependency requires `libpng-dev` library, so it must be installed first in order to get the npm to build successfully. Otherwise, the result will be ELIFECYCLE error.\n\nAs BeeCTF is built on Laravel, please make sure to set the correct parameters in the .env file. To run the system after installation, you can use your own web server (such as Nginx or Apache) or use built-in server by:\n\n```bash\nphp artisan serve\n```\n\n### Docker\nWith [Docker](https://www.docker.com/) (currently for development purposes only, the production image is work in progress):\n\n```bash\ngit clone https://github.com/Newman101/BeeCTF\ncomposer install\ncomposer update\ndocker-compose build\ndocker-compose up -d\ndocker-compose exec app php artisan migrate\ndocker-compose exec app php artisan user:create-admin\n```\n\nAfter creating an administrative user and database connection, the system is ready to use.\n\nIn order to debug any potential issues regarding Docker build, you have a docker-compose shell access with:\n\n```bash\ndocker-compose exec app sh\ndocker-compose exec mysql sh\ndocker-compose exec webserver sh\n```\n\nAlternatively, you can also check which services are up:\n\n```bash\ndocker-compose ps\n```\n\n## API\nThere is an internal API available. This API is used for various purposes, including listing challenges, categories, and getting scoreboard on the command line.\n\n### Get Categories and Challenges\nBeeCTF API allows you to fetch all categories and challenges in JSON format. Syntax as follows:\n\n```bash\ncurl -X GET http://HOST/api/categories?api_token=API_TOKEN -H \"Accept: application/json\" -H \"Content-Type: application/json\"\n```\n\n```bash\ncurl -X GET http://HOST/api/challenges?api_token=API_TOKEN -H \"Accept: application/json\" -H \"Content-Type: application/json\"\n```\n\n### Get Scoreboard\nYou can fetch the scoreboard via BeeCTF API. Example with cURL:\n\n```bash\ncurl -X GET http://HOST/api/scoreboard?api_token=API_TOKEN -H \"Accept: application/json\" -H \"Content-Type: application/json\"\n```\n\nThis command returns the scoreboard in JSON format.\n\n### Get Team Scoreboard\nYou can fetch the team scoreboard via BeeCTF API. Example with cURL:\n\n```bash\ncurl -X GET http://HOST/api/teamscoreboard?api_token=API_TOKEN -H \"Accept: application/json\" -H \"Content-Type: application/json\"\n```\n\nThis command returns the team scoreboard in JSON format.\n\n### Get Number of Solved Challenges\nYou can get number of solved challenges via BeeCTF API. Example with cURL:\n\n```bash\ncurl -X GET http://HOST/api/numbersolved?api_token=API_TOKEN -H \"Accept: application/json\" -H \"Content-Type: application/json\"\n```\n\nThis command returns number of challenges solved in JSON format.\n\n## Pull Requests\nFeel free to send any bug fixes, new features, etc. via pull requests. Please note that BeeCTF is still heavily work in progress so there are a lot of issues to fix and all contributions are welcome. Before submitting unit tests, please make sure all unit tests pass and the code is following the standards established in contribution guide.\n\n## License\nCopyright (c) \u003c2019\u003e Juha Remes\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjremes-foss%2Fbeectf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjremes-foss%2Fbeectf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjremes-foss%2Fbeectf/lists"}