{"id":17295390,"url":"https://github.com/kevinbatdorf/custom-builder","last_synced_at":"2025-08-26T19:29:20.443Z","repository":{"id":146796567,"uuid":"9281053","full_name":"KevinBatdorf/custom-builder","owner":"KevinBatdorf","description":"A custom module builder for any programming language, using GitHub","archived":false,"fork":false,"pushed_at":"2013-04-14T07:23:33.000Z","size":124,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-01T02:15:12.264Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KevinBatdorf.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-07T18:24:38.000Z","updated_at":"2013-10-28T14:35:42.000Z","dependencies_parsed_at":"2023-03-24T08:15:57.733Z","dependency_job_id":null,"html_url":"https://github.com/KevinBatdorf/custom-builder","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/KevinBatdorf%2Fcustom-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinBatdorf%2Fcustom-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinBatdorf%2Fcustom-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KevinBatdorf%2Fcustom-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KevinBatdorf","download_url":"https://codeload.github.com/KevinBatdorf/custom-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245727706,"owners_count":20662556,"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":[],"created_at":"2024-10-15T11:10:10.650Z","updated_at":"2025-03-26T20:16:23.435Z","avatar_url":"https://github.com/KevinBatdorf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[Custom Builder](http://kevinbatdorf.com/custom-builder)\n============\nA custom module builder for any programming language, using GitHub\n\n[Download](https://github.com/KevinBatdorf/custom-builder/zipball/master)\n\n\nWhat Does It Do?\n----------------\n\nBasically it concates files together from Github, allowing users to select which modules they want to include. [Check out an example](http://liquidslider.com/custom-build/)\n\n\nWhy Would I Use It?\n-------------------\n\nIt just gives you one less thing to worry about. Using Github, you can keep your files up to date, rather than worrying about continuously updating them on your server. If your code is not updated often, this plugin probably isnt for you.\n\n\nLimitations\n-----------\n\nYou need to [set up a GitHub application](https://github.com/settings/applications/new) in order to increase the API rate limit from 60 requests to 5000 requests per hour.\n\nIf you have 5 files, the script will make 10 requests. This is because the code first uses the name of the file to retrieve the most recent version number, then uses that version number to grab that file.\n\nI'm not sure how secure the JSON request for the PHP token is, thoughts? \n\nHow to Use\n-----------\n\nFirst, you should only use this if your code can be broken into modules. See [an example of my code](https://github.com/KevinBatdorf/liquidslider/tree/master/modules). I'm using JavaScript (jQuery), but theoretically you can use whatever language you want. \n\nNext, you change the files for each module name in your markup:\n\n```html\n\u003cdiv class=\"cb-options\"\u003e\n  \u003c!-- The Checkboxes --\u003e\n    \u003cinput type='checkbox' data-cbuilder='{\"setting:false\":\"setting:true\"}' value='path/to/module1' id='module1'\u003e\n      \u003clabel for='module1'\u003emodule1\u003c/label\u003e\n    \u003c!-- The Button --\u003e\n    \u003cbutton class=\"compile\"\u003eCompile\u003c/button\u003e\n    \u003cdiv class=\"progress-bar-outer\"\u003e\n        \u003cdiv class=\"progress-bar\" style=\"width: 0%\"\u003e\u003c/div\u003e\n    \u003c/div\u003e\n  \u003c/div\u003e\n```\nI recommend you set the default settings to false in your code, then use the data-cbuilder to set it true on condition that it's included. You can change these as needed.\n\nNotice that you may include a progress bar as well.\n\nThen, edit the following JavaScript settings:\n\n```javascript\n    userName:               \"username\",       // GitHub user name\n    repoName:               \"repository\",     // GitHub repo name\n    sha:                    false,            // Use SHA instead of file name\n    headerFile:             null,             \n    footerFile:             null,             \n    buttonProcessingText:   \"Building...\",\n    buttonFinishedText:     \"Download Now\",\n    progressBarText:        null,             // Optionally add text on complete\n    actionFile:             \"build.php\",\n    authenticate:           false,            // Enable to increase API rate limit\n    loginInfoFile:          \"build.php\",\n    adjustSettings:         true              // In case you need to adjust settings\n```\n\nSome important things to pay attention to. You have to include a header and footer file, two files which would be included in each file regardless. \n\nFinally, depending on your plugin options, you might have to write some additional javascript to set certain values from true to false so that your plugin will work. An automated method might be included in future updates.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinbatdorf%2Fcustom-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinbatdorf%2Fcustom-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinbatdorf%2Fcustom-builder/lists"}