Skip to content

πŸš€ BoilerPlateCreator: An indispensable Bash tool that accelerates your coding workflow by instantly generating language-specific boilerplate files. Kickstart your projects with a single command! πŸ’»βœ¨

jcgonzalez25/BoilerPlateCreator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Boiler Plate Creator for Programming Languages

Version Badge Language Badge License Badge

πŸ“– Table of Contents

πŸ‘οΈ Overview

The Boiler Plate Creator script automates the creation of boilerplate code for various programming languages, easing the setup process for different projects. This tool is essential for developers looking to save time in initializing new coding projects.

✨ Features

  • Multi-Language Support: PHP, CSS, HTML, C, JavaScript, Java.
  • Exercise Integration: Option to include language-specific exercises.
  • File Linking: Append or include links to files in new boilerplates.
  • User-friendly: Easy-to-use commands with a detailed help option.

πŸ› οΈ Installation

Follow these steps to set up the script on your machine:

  1. Clone the Repository:
    git clone [repository-url]
  2. Navigate to the Directory:
    cd [script-directory]
  3. Make the Script Executable:
    chmod +x boiler

πŸš€ Usage

Use the following syntax for the script:

boiler <languageOfBoiler> [option] [FileName]

Examples:

  • Create a C file: boiler c example1
  • JavaScript file with exercise: boiler js -ex
  • HTML file with CSS/JS: boiler html -include *.js *.css app
  • Add CSS link to HTML: boiler css -addTo index.html app

βš™οΈ Options

  • -ex: Exercise file with relevant question.
  • -addTo PathToFile(s): Append links to the file(s).
  • -include PathToFile(s): Create a file with links to specified file(s).
  • -help: Help information on command usage.

❓ FAQ

Q: Can I use this script on any operating system? A: The script is designed for Unix-like operating systems and might require adaptations for others.

Q: How do I contribute to the script? A: Please see the Contributing section below.

🀝 Contributing

Contributions are welcome! If you have suggestions or want to add features:

  1. Fork the project.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

About

πŸš€ BoilerPlateCreator: An indispensable Bash tool that accelerates your coding workflow by instantly generating language-specific boilerplate files. Kickstart your projects with a single command! πŸ’»βœ¨

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages