Skip to content

Home

Jump to bottom
Nicholas Ikiroma edited this page Aug 17, 2024 · 3 revisions

TailGen Wiki

Welcome to the official TailGen Wiki! This documentation is designed to help you understand and effectively use TailGen to generate Flask or FastAPI projects integrated with Tailwind CSS.

Overview

TailGen is a command-line interface (CLI) tool that streamlines the creation of web applications by generating boilerplate code for Flask or FastAPI projects with Tailwind CSS integration. It automates the setup process, allowing you to focus more on building features rather than configuring your development environment.

Features

  • Virtual Environment Management: Automatically creates a virtual environment for your project and installs all necessary Python dependencies within the venv folder to ensure isolated and manageable dependencies.

  • Template Generation: Generates customizable Flask or FastAPI project templates integrated with Tailwind CSS, including organized directory structures and starter code to kickstart your development.

  • Cross-Platform Compatibility: Designed to work seamlessly on both Windows and Unix-like systems, providing a consistent experience across different operating systems.

  • Git Initialization: Initializes a Git repository for your project, setting up version control from the get-go.

Prerequisites

Before installing and using TailGen, ensure your system meets the following requirements:

  • Python 3.x: TailGen is built for Python 3. Make sure you have Python 3 installed on your system. You can download it from the official Python website.

  • Node.js and NPM: Required for installing and managing Tailwind CSS. Download and install from the official Node.js website.

Installation

You can easily install TailGen using pip. Open your terminal and run the following command:

pip install tailgen

This command will download and install the latest version of TailGen from PyPI.

Getting Started

Once installed, you can start using TailGen to generate your project templates. Visit the Usage page for detailed instructions and examples on how to use TailGen effectively.

Contributing

Contributions to TailGen are welcome! If you have ideas for new features, improvements, or bug fixes, feel free to open an issue or submit a pull request. For more details, check out the Contributing Guidelines.

License

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

Clone this wiki locally