https://github.com/t4t5/boom
A fast & simple boilerplate generator, built with Rust. 🦀
https://github.com/t4t5/boom
Last synced: 5 months ago
JSON representation
A fast & simple boilerplate generator, built with Rust. 🦀
- Host: GitHub
- URL: https://github.com/t4t5/boom
- Owner: t4t5
- Created: 2021-10-13T07:19:19.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-27T15:49:55.000Z (over 3 years ago)
- Last Synced: 2024-05-02T06:07:29.572Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 26.4 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Boom 💥
A fast & simple boilerplate generator, built with Rust.
## Installing boom
**This package is not yet downloadable on Brew or other package managers, so for now installing it takes slightly more work.**
1. Clone this repo into the directory of your choice:
```bash
git clone https://github.com/t4t5/boom.git
```
2. Compile the code:
```bash
cd boom && cargo build
```
3. Set an alias for "boom" in your `.zshrc` or `.bash_profile`:
```bash
alias boom="{YOUR_DIR}/boom/target/debug/boom"
```
## Using boom
Boom will automatically create a `.boom` folder in your home directory. This is where all your boilerplate generators will be stored.
You can add this directory to your version-controlled [dotfiles](https://thoughtbot.com/upcase/videos/intro-to-dotfiles) so that you don't lose your library of boilerplate templates.
### Adding a boom template
To create a new boom template, run:
```bash
boom new
```
A new `` directory will be created in your `.boom` folder, with a `boilerplate` directory and an `init.sh` file inside it.
Add the files you want for your boilerplate to the `boilerplate` directory, and the commands you want to run when starting a project using to `init.sh` (e.g. "npm install").
### Using your new boom template
```bash
boom
```
This will create a new folder called `` in whatever directory you're currently in, using the `` boilerplate.
### Adding others' templates
We encourage you to share your boom templates in a public dotfiles repo! That way, others can find and use your templates in their own projects.
To quickly clone someone else's template, you first need to install [github-clone](https://github.com/HR/github-clone):
```bash
pip install github-clone
```
Now let's say you want to add [t4t5's eleventy template](https://github.com/t4t5/dotfiles/tree/master/boom/templates/eleventy) to your own boom templates. You can then simply run:
```bash
boom add https://github.com/t4t5/dotfiles/tree/master/boom/templates/eleventy
```
You can now use this boilerplate using:
```bash
boom eleventy
```
## Todos
- [ ] Remove dependency on [github-clone](https://github.com/HR/github-clone)
- [ ] Show the output of scripts from templates' `init.sh` (so that you can see progress of `npm install` for example)
- [ ] Support calling `boom` command without any arguments. Show an interactive UI where you can pick from your templates.