fot
Version:
A simple tool that lets you start a project without the hassle of creating the same folders over and over again. Create once... and never again.
136 lines (73 loc) • 4.12 kB
Markdown
[](https://badge.fury.io/js/fot)
***FO - T***
======
Also known as "folder-template," **fot** is a simple tool that lets you start a project *without the hassle of creating the same folders over and over again.* **Create once... and never again.**
**Installation**
------------
Open your command line/terminal and type the following:
>**npm install fot -g**
**Setup**
-----
To let **FO - T** know where to look for, when cloning templates.
**To setup your installation of *FO - T* do the following:**
1. Create a folder containing all of the templates you would like to use and navigate into that folder using your cmd/terminal.
2. Type the following in your cmd/terminal: **`fot here`**
>Alternatively: You could use
>**```fot set {{arg}}```**
>Here - '**arg**' is the absolute path to ***inside*** your templates folder.
3. That's it, You're all set! Mom's gonna be really proud...
>**Note**: You can change your templates directory by doing the steps above with another path or you can clear the path(more about that in the next section.)
**Commands**
------------
- **```fot here```**: Set the templates directory to the working directory.
- **```fot get```**: Get the template directory's absolute path.
- **```fot set {abs-path}```**: Set the templates directory to the absolute path {abs-path}
- **```fot clone {template} {OPTIONAL new filename}```**: Clone a template into the working directory.
- **```fot clear```**: Forgets your templates dir.
- **```fot list```**: Lists all the templates in your templates dir.
**Usage**
-----
To clone a template simply:
1. Navigate into your project folders ***parent directory***.
2. Type
>**```fot clone {{template name(inside your templates folder)}} {{OPTIONAL new foldername}}```**
**EXAMPLE**
------------------
[pic1]: https://github.com/Frixoe/fot/raw/master/res/img/pic1.png
[pic2]: https://github.com/Frixoe/fot/raw/master/res/img/pic2.PNG
[pic3]: https://github.com/Frixoe/fot/raw/master/res/img/pic3.PNG
[pic4]: https://github.com/Frixoe/fot/raw/master/res/img/pic4.PNG
[pic5]: https://github.com/Frixoe/fot/raw/master/res/img/pic5.PNG
[pic6]: https://github.com/Frixoe/fot/raw/master/res/img/pic6.PNG
[pic7]: https://github.com/Frixoe/fot/raw/master/res/img/pic7.PNG
[pic8]: https://github.com/Frixoe/fot/raw/master/res/img/pic8.PNG
[pic9]: https://github.com/Frixoe/fot/raw/master/res/img/pic9.PNG
[pic10]: https://github.com/Frixoe/fot/raw/master/res/img/pic10.PNG
Billy is a developer. And with every project, Billy needs to create a lot of folders, files and most of the time needs to write the same boiler plate code **over and over again** UGH... Billy doesn't like this.
Trying to combat this problem, Billy stumbles upon ***FO - T***: the easiest tool to use for folder-templates.
Now Billy can just move all of his boiler plate folders and files(with the code) to one directory and clone the templates from there whenever he wants to start a new project! ***Billy loves this!***
**Billy does the following:**
- He creates a 'templates' folder in his documents because he finds that convenient.
![you][pic2]
![better][pic1]
- In his command prompt, he goes inside the templates folder and does the following to set his templates directory.
![appreciate][pic4]
![this][pic5]
- He then creates a template which he knows he will be using a lot in the future.
![elaborate][pic3]
INSIDE:
![documentation][pic9]
- Now he can clone any folder/file from inside the 'templates' folder to anywhere he wants, with **ease.**
- He goes inside his 'projects' folder which is in his documents folder and types just ***ONE*** command to clone all of his files into the projects folder. Oh and he also renames it.
BEFORE:
![cuz][pic6]
![this][pic7]
AFTER:
![took a lot][pic8]
INSIDE:
![of time...][pic10]
***Be smart like Billy, use ***FO - T*** , and save your **precious** time.***
------
**LICENSE**
-------
MIT