{"id":13849942,"url":"https://github.com/atomist-attic/spring-rugs","last_synced_at":"2025-07-12T21:32:26.541Z","repository":{"id":141018982,"uuid":"75132001","full_name":"atomist-attic/spring-rugs","owner":"atomist-attic","description":"Atomist project generator for a new Spring Boot Rest Service","archived":true,"fork":false,"pushed_at":"2017-08-09T21:50:47.000Z","size":152,"stargazers_count":5,"open_issues_count":13,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-22T15:02:53.685Z","etag":null,"topics":["atomist","java","rugs","spring","spring-boot","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atomist-attic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2016-11-29T23:31:04.000Z","updated_at":"2023-01-28T18:46:40.000Z","dependencies_parsed_at":"2024-01-15T22:01:10.395Z","dependency_job_id":null,"html_url":"https://github.com/atomist-attic/spring-rugs","commit_stats":null,"previous_names":["atomist/spring-rugs"],"tags_count":80,"template":false,"template_full_name":null,"purl":"pkg:github/atomist-attic/spring-rugs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Fspring-rugs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Fspring-rugs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Fspring-rugs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Fspring-rugs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atomist-attic","download_url":"https://codeload.github.com/atomist-attic/spring-rugs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atomist-attic%2Fspring-rugs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264910716,"owners_count":23682121,"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":["atomist","java","rugs","spring","spring-boot","typescript"],"created_at":"2024-08-04T20:00:53.518Z","updated_at":"2025-07-12T21:32:26.297Z","avatar_url":"https://github.com/atomist-attic.png","language":"TypeScript","funding_links":[],"categories":["Video Collections"],"sub_categories":[],"readme":"# Atomist 'spring-rugs'\n\n[![Build Status](https://travis-ci.org/atomist/spring-rugs.svg?branch=master)](https://travis-ci.org/atomist/spring-rugs)\n\nThis [Rug][rug] project contains a generator for a [Spring Boot][boot]\n[REST][rest] service project.\n\n[rug]: http://docs.atomist.com/\n\n## Rugs\n\nRugs are typically run using the Atomist Bot in Slack.  To run Rugs\nlocally, you must first install the following tools:\n\n-   [Rug CLI][rug-cli]\n-   [Node.js][node]\n\n[rug-cli]: http://docs.atomist.com/user-guide/interfaces/cli/install/\n[node]: https://nodejs.org/\n\nOnce those tools are installed, you can clone this repository and\ninstall its dependencies with the following command.\n\n```\n$ ( cd .atomist \u0026\u0026 npm install )\n```\n\n### NewSpringBootRestService\n\nThe NewSpringBootRestService generator creates a new [Spring\nBoot][boot] [REST][rest] service project.\n\n[boot]: https://projects.spring.io/spring-boot/\n[rest]: https://en.wikipedia.org/wiki/Representational_state_transfer\n\n#### Prerequisites\n\nThere are no prerequisites to running this generator.\n\n#### Parameters\n\nTo run this generator you must supply the following parameters.\n\nName | Required | Default | Description\n-----|----------|---------|------------\nProject Name | Yes | |  A valid GitHub repository name.  It should be 21 characters or less to avoid truncating name when the its Slack channel is created.\n`artifactId` | No | myartifact | Maven artifact ID, e.g., \"fiddle-riddle\".\n`groupId` | No | mygroup |  Maven group ID, e.g., \"com.pany.project\".\n`version` | No | 0.1.0-SNAPSHOT | [Semantic version][semver] of the project.\n`description` | No | My new project | A brief description of the project.\n`rootPackage` | No | com.myorg | The root package for the generated service class.\n`serviceClassName` | No | MyService | Name for the generated service class.\n\n[semver]: http://semver.org\n\n#### Running\n\nRun it as follows:\n\n```\n$ cd parent/directory\n$ rug generate atomist:spring-rugs:NewSpringBootRestService \\\n    pet-shop-service \\\n    artifactId=pet-shop \\\n    groupId=uk.co.lndn \\\n    version=0.1.0-SNAPSHOT \\\n    description=\"Spring Boot REST service for selling stuff\" \\\n    rootPackage=uk.co.lndn.electronic \\\n    serviceClassName=PetShop\n```\n\nNote the first parameter, the project name, is different in that you\ndo not need to supply the name of the parameter, just the value.  This\nis because the project name parameter is required for all generators.\nThis will create a directory named `pet-shop-service` and populate it\nwith a working Spring Boot REST service.  If you are happy with the\nchange, commit the changes.\n\n```\n$ cd pet-shop-service\n$ git init\n$ git add .\n$ git commit -m 'Initial version generated by Atomist'\n```\n\nSee the README in the generated project for further instructions.\n\n## Rug Support\n\nGeneral support questions should be discussed in the `#support`\nchannel on our community Slack team\nat [atomist-community.slack.com][slack].\n\nIf you find a problem, please create an [issue][].\n\n[issue]: https://github.com/atomist/spring-rugs/issues\n\n## Rug Contributing\n\nIf you are interested in contributing to the Atomist open source\nprojects, please see our [contributing guidelines][contrib] and\nour [code of conduct][code].\n\n[contrib]: https://github.com/atomist/welcome/blob/master/CONTRIBUTING.md\n[code]: https://github.com/atomist/welcome/blob/master/CODE_OF_CONDUCT.md\n\n## Rug Development\n\nYou can build, test, and install the project locally with\nthe [Rug CLI][cli].\n\n[cli]: https://github.com/atomist/rug-cli\n\n```\n$ rug test\n$ rug install\n```\n\nTo create a new release of the project, simply push a tag of the form\n`M.N.P` where `M`, `N`, and `P` are integers that form the next\nappropriate [semantic version][semver] for release.  For example:\n\n[semver]: http://semver.org\n\n```\n$ git tag -a 1.2.3\n```\n\nThe Travis CI build (see badge at the top of this page) will\nautomatically create a GitHub release using the tag name for the\nrelease and the comment provided on the annotated tag as the contents\nof the release notes.  It will also automatically upload the needed\nartifacts.\n\n## Spring Boot REST Service\n\n[boot]: https://projects.spring.io/spring-boot/\n[rest]: https://en.wikipedia.org/wiki/Representational_state_transfer\n\n## Development\n\nThis project is driven using [Maven][mvn].  You will need to install\nMaven locally to build, run, and test this project.\n\n[mvn]: https://maven.apache.org/\n\n### Run locally\n\nYou can run the service locally using the following from the command:\n\n```\n$ mvn spring-boot:run\n```\n\n### Run tests\n\nThis service comes with some rudimentary tests as a good starting\npoint for writing your own.  Use the following command to execute the\ntests using Maven:\n\n```\n$ mvn test\n```\n\n---\nCreated by [Atomist][atomist].\nNeed Help?  [Join our Slack team][slack].\n\n[atomist]: https://www.atomist.com/\n[slack]: https://join.atomist.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Fspring-rugs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatomist-attic%2Fspring-rugs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatomist-attic%2Fspring-rugs/lists"}