{"id":20777384,"url":"https://github.com/oxguy3/coebot-www","last_synced_at":"2025-04-30T18:28:32.245Z","repository":{"id":24187282,"uuid":"27578267","full_name":"oxguy3/coebot-www","owner":"oxguy3","description":"A web interface for CoeBot, a Twitch chat bot","archived":false,"fork":false,"pushed_at":"2017-01-11T19:12:35.000Z","size":21270,"stargazers_count":12,"open_issues_count":2,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-30T18:51:08.594Z","etag":null,"topics":["php","pusher","twitch"],"latest_commit_sha":null,"homepage":"http://coebot.tv","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxguy3.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}},"created_at":"2014-12-05T06:36:08.000Z","updated_at":"2024-12-28T19:48:07.000Z","dependencies_parsed_at":"2022-08-22T12:10:53.130Z","dependency_job_id":null,"html_url":"https://github.com/oxguy3/coebot-www","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxguy3%2Fcoebot-www","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxguy3%2Fcoebot-www/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxguy3%2Fcoebot-www/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxguy3%2Fcoebot-www/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxguy3","download_url":"https://codeload.github.com/oxguy3/coebot-www/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251760001,"owners_count":21639323,"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":["php","pusher","twitch"],"created_at":"2024-11-17T13:15:13.440Z","updated_at":"2025-04-30T18:28:32.196Z","avatar_url":"https://github.com/oxguy3.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# coebot-www\nA web interface for [CoeBot](https://bitbucket.org/tucker_gardner/coebot), a Twitch.tv chat moderation bot.\n\n## Installation\nThis site is still very early in development so I'm not gonna bother writing detailed install instructions that might change dramatically later, but it's mostly just a standard AMP (Apache/MySQL/PHP) application. Put the files on an Apache server with PHP and enable .htaccess files or copy the contents of the .htaccess file to your Apache config file. The database structure can be rebuilt using the file dbstructure.sql (which I will do my best to keep up to date).\n\nYou might notice that one particular file is missing. To keep secret data safe, I put confidential details in a file called safeconfig.php that isn't posted to GitHub. Here's what that file looks like so that you can recreate it:\n\n```php\n\u003c?php\n\ndefine('SITE_DOMAIN', \"coebot.tv\"); // change to your domain name\ndefine('SITE_ENV', \"PROD\"); // set to \"PROD\" or \"TEST\" depending on if the site is live or not\n\n// mysql details for new site\ndefine('DB_SERV', \"\u003cip/hostname of mysql server\u003e\");\ndefine('DB_USER', \"\u003cmysql username\u003e\");\ndefine('DB_PASS', \"\u003cmysql password\u003e\");\ndefine('DB_NAME', \"\u003cmysql database name\u003e\");\ndefine('DB_PREF', \"\u003cprefix to prepend to all table names\u003e\");\n\n// mysql details for highlights site\ndefine('DB_HIGHLIGHTS_SERV', \"\u003cip/hostname of mysql server\u003e\");\ndefine('DB_HIGHLIGHTS_USER', \"\u003cmysql username\u003e\");\ndefine('DB_HIGHLIGHTS_PASS', \"\u003cmysql password\u003e\");\ndefine('DB_HIGHLIGHTS_DATA', \"\u003cmysql database name\u003e\");\n\n// twitch api keys\ndefine('TWITCH_CLIENT_SECRET', \"\u003ctwitch api client secret\u003e\");\ndefine('TWITCH_CLIENT_ID', \"\u003ctwitch api client id\u003e\");\ndefine('TWITCH_REDIRECT_URI', \"http://coebot.tv/twitchconnect.php\"); // change \"coebot.tv\" to your domain name\ndefine('TWITCH_REQUIRED_SCOPES', \"user_read\"); // shouldn't need to change this\n\n// twitch usernames (all lowercase) of anyone who should have admin powers on the website\n$GLOBAL_ADMINS = array('itsoxguy3', 'endsgamer');\n\n?\u003e\n```\n\nThe site is in pretty rapid development right now and this version of the file is going to become outdated (in fact, it already is); please contact me if you need help with this.\n\nThe other issue you will find is that the `.htaccess` currently has rules set up to forward all non-www/non-https requests to \"https://www.coebot.tv/\". You'll need to modify or remove these rules to run the site on your own host. There are [a number of reasons](http://www.yes-www.org/) why I recommend enforcing the \"www.\" prefix, but the site should work just fine without it.\n\n## Private API\nThis site uses a private API to communicate with CoeBot. This API is still in planning and is rapidly evolving (do not assume currently existing endpoints will exist indefinitely), but the specification so far is available [here](https://docs.google.com/document/d/1tQNETtRvTuSdGKEep57yuO_8J_YfjS5J3--Q6vH0Rcc/edit?usp=sharing). The source code of api.php is considered more canonical than this document for the time being however.\n\n## License\nCoeBot.tv: A website for CoeBot, the Twitch chat moderation bot\n\nCopyright (C) 2014-2017 Hayden Schiff*\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nThe full text of the license can be found in the file LICENSE,\nor at [http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html).\n\n*The original code for the \"highlight that\" functionality is Copyright (C) 2014 Stijn Van Baekel (stinusmeret)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxguy3%2Fcoebot-www","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxguy3%2Fcoebot-www","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxguy3%2Fcoebot-www/lists"}