Skip to content

The Project Template Generator is a command-line interface (CLI) application written in Rust. It allows you to quickly generate a project template with a predefined directory structure and common files for your coding projects.

License

Notifications You must be signed in to change notification settings

Isaaruwu/Template-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Template Generator

The Project Template Generator is a command-line interface (CLI) application written in Rust. It allows you to quickly generate a project template with a predefined directory structure and common files for your coding projects.

Features

  • Generates a tailored template for different languages and different types of projects.
  • Customizable project name.
  • You can use the git flag (-g) to initialize a git repo with a gitignore template based on the chosen language
  • Easy setup and usage.

Installation

  1. Make sure you have Python 3 installed on your system. You can download it from the official Python website (https://www.python.org).
  2. Make sure you have Rust installed on your system. You can download and install it from the official Rust website (https://www.rust-lang.org/tools/install).
  3. Clone this repository or download the source code.
   git clone https://github.com/Isaaruwu/Template-Generator.git
  1. Build the project
   cargo build --release
  1. Add the generated target/release folder to your system's environments variables

Usage

  1. To generate a project template in your current directory run
   tgen create <language> <project_name> [project_type] [path] [-g]

NB. For additionnal help

   tgen --help

Supported languages

Right now the project supports:

  • Python (default and data-science project type)

Future Development

This Project Template Generator is an ongoing project, and there are several areas that can be improved and expanded. Some ideas for future development include:

  • Supporting different langages
  • Implementing templates for specific project types (e.g., web applications, etc).
  • Enhancing the CLI interface with more interactive features and options.

License

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

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

Acknowledgments

This project was inspired by the need for a quick and standardized way to set up Python projects. gitignore templates are from [https://github.com/github/gitignore/tree/main]

About

The Project Template Generator is a command-line interface (CLI) application written in Rust. It allows you to quickly generate a project template with a predefined directory structure and common files for your coding projects.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages