https://github.com/jamf/rendr
A project scaffolding tool
https://github.com/jamf/rendr
Last synced: 11 months ago
JSON representation
A project scaffolding tool
- Host: GitHub
- URL: https://github.com/jamf/rendr
- Owner: jamf
- License: mit
- Created: 2020-06-25T15:01:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T17:47:30.000Z (almost 3 years ago)
- Last Synced: 2024-11-21T22:52:03.762Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 1.32 MB
- Stars: 10
- Watchers: 7
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rendr
_A project scaffolding tool_
[](https://github.com/jamf/rendr/blob/master/LICENSE)
[](https://github.com/jamf/rendr/releases)
[](https://jamf.github.io/rendr/)
Check out the [User Guide](https://jamf.github.io/rendr/) for the full documentation.
## Features
_rendr_ is a scaffolding tool which allows generating entire projects (or anything else) from blueprints, using standard templating engines and simple customization via parameters. It is generic enough to apply to a wide variety of applications and tech stacks, but powerful and flexible enough to provide value, fast. The tool itself is really a generic template renderer. It's up to you, the template creator, to decide what to put in your template.
### Use cases
Here are just a few possible use cases:
* Enable rapid spin-up of new projects, complete with CI/CD pipelines, code quality gates, security analysis, and more
* Ship "Hello, World!" projects immediately to production, enabling instant iteration on features
* Include CI/CD standards baked into projects from the start, easily kept up to date
* Simplify repeated patterns like creating new microservices, libraries, or submodules on an existing project
### Sample blueprints
Check out the sample blueprints to get a feel for what is possible:
* https://github.com/jamf/rendr-sample-blueprint-hello-world
* https://github.com/jamf/rendr-sample-blueprint-go-microservice
Creating your own blueprint is easy! The details are documented in the [User Guide](https://jamf.github.io/rendr/).
## Installation
### Homebrew
To install the latest release:
```sh
brew install jamf/tap/rendr
```
### Cargo (from source)
Again, the latest release can be installed with:
```sh
cargo install rendr
```
### Binaries for Linux and macOS
Alternatively, you can download the CLI binary directly from the [Releases](https://github.com/jamf/rendr/releases) page and put it on your system path.
## Usage
More detailed usage can be found [in the User Guide](https://jamf.github.io/rendr/usage.html).
View available commands:
```sh
❯ rendr help
```
The basic usage to generate a project looks like this:
```sh
rendr create --blueprint https://github.com/your/template --dir my-project
```
Provide values to the template with the `-v` flag:
```sh
rendr create -b https://github.com/your/template -d my-project -v name:foo -v version:1.0.0
```
## Contributing
Feedback and pull requests are welcome! Let us know if you have issues using the tool, or see use cases that are not yet supported. We'd love to expand its usefulness!