{"id":24854470,"url":"https://github.com/cbrnrd/radon","last_synced_at":"2025-10-15T00:31:43.528Z","repository":{"id":56890338,"uuid":"152018127","full_name":"cbrnrd/radon","owner":"cbrnrd","description":"🤖 Create starter code for all different environments","archived":false,"fork":false,"pushed_at":"2020-02-29T14:00:35.000Z","size":2564,"stargazers_count":5,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-17T05:46:24.176Z","etag":null,"topics":["boilerplate","code","code-generator","ruby"],"latest_commit_sha":null,"homepage":"https://periodic.now.sh/","language":"Ruby","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/cbrnrd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":"https://liberapay.com/cbrnrd/","issuehunt":null,"otechie":null,"custom":"https://carterbrainerd.me/donations/"}},"created_at":"2018-10-08T04:22:04.000Z","updated_at":"2021-05-14T12:28:04.000Z","dependencies_parsed_at":"2022-08-21T00:50:21.851Z","dependency_job_id":null,"html_url":"https://github.com/cbrnrd/radon","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbrnrd%2Fradon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbrnrd%2Fradon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbrnrd%2Fradon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cbrnrd%2Fradon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cbrnrd","download_url":"https://codeload.github.com/cbrnrd/radon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236540051,"owners_count":19165636,"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":["boilerplate","code","code-generator","ruby"],"created_at":"2025-01-31T15:38:16.456Z","updated_at":"2025-10-15T00:31:38.122Z","avatar_url":"https://github.com/cbrnrd.png","language":"Ruby","funding_links":["https://liberapay.com/https://liberapay.com/cbrnrd/","https://carterbrainerd.me/donations/"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/cbrnrd/radon/master/img/radon-readme-header.png\"\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/cbrnrd/radon/master/img/demo.gif\"\u003e\u003c/p\u003e\n\n## Installation\n\n`radon` is part of the [periodic](https://periodic.now.sh) collection of apps. If you install `periodic-cli`, radon should come with it:\n\n    $ gem install periodic-cli\n\nOr install just the gem:\n\n    $ gem install radon\n\n## Usage\n\nThe basic usage is as follows: `radon [environment] {ProjectName}`.\n\nA full list of supported environments can be found by running `radon --list-env`\n\n#### Example:\n\nHere is radon generating a gradle project called MyGradleProject\n```\n$ radon gradle MyGradleProject\nCreating project under /mnt/c/Users/Carter/Desktop/projects/MyGradleProject\n  create MyGradleProject\n  create MyGradleProject/.gradle/\n  create MyGradleProject/.gradle/4.5/\n  create MyGradleProject/.gradle/4.5/fileChanges/\n  create MyGradleProject/.gradle/4.5/fileChanges/last-build.bin\n  create MyGradleProject/.gradle/4.5/fileHashes/\n  create MyGradleProject/.gradle/4.5/fileHashes/fileHashes.bin\n  create MyGradleProject/.gradle/4.5/fileHashes/fileHashes.lock\n  create MyGradleProject/.gradle/4.5/taskHistory/\n  create MyGradleProject/.gradle/4.5/taskHistory/taskHistory.bin\n  create MyGradleProject/.gradle/4.5/taskHistory/taskHistory.lock\n  create MyGradleProject/.gradle/buildOutputCleanup/\n  create MyGradleProject/.gradle/buildOutputCleanup/buildOutputCleanup.lock\n  create MyGradleProject/.gradle/buildOutputCleanup/cache.properties\n  create MyGradleProject/.gradle/buildOutputCleanup/outputFiles.bin\n  create MyGradleProject/build.gradle\n  create MyGradleProject/gradle/\n  create MyGradleProject/gradle/wrapper/\n  create MyGradleProject/gradle/wrapper/gradle-wrapper.jar\n  create MyGradleProject/gradle/wrapper/gradle-wrapper.properties\n  create MyGradleProject/gradlew\n  create MyGradleProject/gradlew.bat\n  create MyGradleProject/settings.gradle\n  create MyGradleProject/src/\n  create MyGradleProject/src/main/\n  create MyGradleProject/src/main/java/\n  create MyGradleProject/src/main/test/\nDone! Your project is set up in /mnt/c/Users/Carter/Desktop/projects/MyGradleProject.\n```\n\n## Supported Environments\nAs of v0.1.7, the current supported environments are:\n* Gradle\n* Java\n* Maven\n* Python\n* C\n* Ruby\n* Crystal\n* Go (simple)\n* Website\n\n## Development\n\n#### Adding an environment\nIf you want to add an environment to radon, here are the steps:\n1. Create the standard directory structure of that environment. This is usually found on the environment's website or just through convention.\n2. Zip all the files into one file (`zip -r env.zip .`)\n3. Save the zip data as base64 (`cat env.zip | base64 -w 0 \u003e env.b64`)\n4. Put both the base64 data and the zip file in radon's `/data` folder.\n5. Add the function(s) in `extract.rb` to extract the _zip_ file to the target (See [here](https://github.com/cbrnrd/radon/blob/7cd141b5a61de6a8abaf0009a1a8cfd090f05e97/lib/core/extract.rb#L5))\n6. Add the environments to `@@all` in `environments.rb`\n7. Open a pull request\n\nIf the environment requires a project name (eg. ruby class name or file-names) you can put these token identifiers to be replaced during project creation:\n\n| Identifier        | Meaning           |\n| :-------------: |:-------------:|\n| `{{NAME}}`      | The dash-seperated project name (eg. `my-cool-project`) |\n| `{{CAPSNAME}}`      | The capitalized project name (eg. `MyCoolProject`) |\n| `{{EMAIL}}` | The email of the user |\n| `{{GHNAME}}` | The GitHub username of the user |\n\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/cbrnrd/radon. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Radon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cbrnrd/radon/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbrnrd%2Fradon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcbrnrd%2Fradon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcbrnrd%2Fradon/lists"}