One Stop Solution for all boilerplate needs!
Consider leaving a
Templa-rs
Templa-rs is a one-of-a-kind TUI tool written in Rust, which helps you generate boilerplate templates for various types of projects and architectures in a matter of seconds!
Usage
- Download templa-rs here
- Run templa-rs
- Find the boilerplate you want
- Press [ENTER] to select it
- Start Coding
You can exit the program at any time using Ctrl+C
Running templa-rs
Windows
If you only wish to use Live Search you can run templa-rs on Windows by simply double clicking the exe file.
If you wish to use CLI queries:
- Open a Terminal Window in the directory that the executable is in
- Run
./templa-rs.exe [OPTIONS]
Linux and macOS
- Open a Terminal window in the directory that templa-rs is in
- Run
tar -zxvf {templa-file-name}.tar.gz - Then run
./templa-rs [OPTIONS]
Features
Live Search
Live Search is a tool that lets you narrow down your search for the boilerplate you need, while also remaining inside the TUI at all times saving you time.
Live Search Features:
- One way to use Live Search is to simply type a search term such as
php, this will then show you all the boilerplates withphpin their name TAG:Tag allows you to search each boilerplate for a specific catagory of boilerplates (e.g.TAG:backend), using multiple tags may narrow down your search further
More methods to narrow down your search may be coming in the future so keep your eyes out!
Command Line Queries
You can also use queries directly from the command line to refine your search:
Template Preview
The Template Preview will show you a tree of the files that will be created when loading the boilerplate.
Built With
Landing Page
This is the design of the Landing Page website. It is not yet developed, if interested in developing this website, please contribute to issue#54.
Link to the design: Figma File
Getting Started Contributing
Got a great new feature or a boilerplate you want to add? Why not contribute to the project:
- Fork it.
- Clone your forked repo and move inside it:
git clone https://github.com/{your-username}/templa-rs.git && cd templa-rs
- Checkout to a new branch to work on an issue:
git checkout -b my-amazing-feature
- Run It Locally
cargo run
- Once you're all done coding, it's time to open a PR :) Run the following commands from the root of the project directory:
git add .
git commit -m "A short description about the feature."
git push origin <my-amazing-feature>
Open your forked repo in your browser and then raise a PR to the master branch of this repository!
Contributing
To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled as difficulty-easy or good-first-issue. Check out issues labelled as hacktoberfest if you are up for some grabs! :)
License
This project is licensed under MIT.