Table of Contents
About The Project
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
To build your own verison of this script you will need.
- Cargo
- Rust
# if you use rustup update rust using:
Installation
- Clone the repo
- Build the release
- The executable is then stored in:
Usage
Create a react component either class or function (default class)
USAGE: crf [OPTIONS]
FLAGS: -h, --help Prints help information -V, --version Prints version information
OPTIONS: -t, --type Type of component (-t c or -t f) [default: c]
ARGS: Name of component
An example use case would be:
This would create a js file named "Example.js" in the current working directory The file would contain a boilerplate class file that would look like:
The default behavior of the tool is to create a class, however if you would like to make a functional component we've got you covered.
Simply use the function tag as such:
This will create a js file named "Example.js" with the following boilerplate:
Happy Hacking!
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Spencer Faith - @13sfaith - 13sfaith@gmail.com
Project Link: https://github.com/13sfaith/crf