README.md

Folder Structure Generator

Table of Contents

• Introduction
• Features
• Visual Preview
• Project Structure
• Installation
• Usage
• Contributing
• License

Introduction

Folder Structure Generator is a tool that allows users to generate elegant folder structure visualizations from any GitHub repository.

Features

• Fetches and displays folder structure from public GitHub repositories.
• Provides a clean markdown output.
• Copy or download the generated folder structure.
• User-friendly UI with Tailwind CSS.

Visual Preview

Project Structure

fostgen/
├─ public
│  ├─ favicon.png
│  ├─ file.svg
│  ├─ fostgen.png
│  ├─ globe.svg
│  ├─ next.svg
│  ├─ vercel.svg
│  └─ window.svg
├─ src
│  ├─ app
│  │  ├─ favicon.ico
│  │  ├─ globals.css
│  │  ├─ layout.tsx
│  │  └─ page.tsx
│  ├─ components
│  │  ├─ Header.tsx
│  │  ├─ InputForm.tsx
│  │  ├─ Notification.tsx
│  │  └─ OutputDisplay.tsx
│  └─ utils
│     └─ githubApi.ts
├─ .gitignore
├─ eslint.config.mjs
├─ LICENCE
├─ next.config.ts
├─ package-lock.json
├─ package.json
├─ postcss.config.mjs
├─ README.md
├─ tsconfig.json
└─ turbo.json

Installation

1. Clone the repository:

   git clone https://github.com/idugeni/fostgen.git

2. Navigate to the project directory:

   cd fostgen

3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

Usage

1. Open the application in your browser.
2. Enter a valid GitHub repository URL.
3. Click on "Generate Structure" to fetch and display the folder structure.
4. Copy or download the generated markdown file.

Contributing

Contributions are welcome! Follow these steps:

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature-branch

3. Make your changes and commit them:

   git commit -m "Add new feature"

4. Push to your forked repository:

   git push origin feature-branch

5. Create a Pull Request.

License

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