📌 Overview

FileStruct is a project developed using Next.js 13 with Shadcn for UI. It allows users to generate an ASCII file tree by pasting a GitHub repository link. The project is deployed on Vercel, offering a user-friendly interface for visualizing the structure of GitHub repositories.

🔍 Table of Contents

• 📁 Project Structure

• 📝 Project Summary

• 💻 Stack

• 🚀 Run Locally

• 🙌 Contributors

📁 Project Structure

├── .eslintrc.json
├── .gitignore
├── README.md
├── app
│   ├── favicon.ico
│   ├── generate
│   │   └── page.tsx
│   ├── globals.css
│   ├── layout.tsx
│   └── page.tsx
├── components.json
├── components
│   ├── Footer.tsx
│   ├── Form.tsx
│   ├── Header.tsx
│   ├── ProjectStruct.tsx
│   ├── theme-provider.tsx
│   └── ui
│       ├── button.tsx
│       ├── input.tsx
│       ├── toast.tsx
│       ├── toaster.tsx
│       └── use-toast.ts
├── lib
│   ├── fileTree.ts
│   └── utils.ts
├── next.config.js
├── package-lock.json
├── package.json
├── postcss.config.js
├── public
│   ├── next.svg
│   └── vercel.svg
├── state
│   └── tree-structure.ts
├── tailwind.config.ts
├── tsconfig.json
└── types
    └── index.ts

📝 Project Summary

• app: Main application logic and entry point.
• components: Reusable UI components used throughout the application.
• lib: External libraries or utility functions used in the project.
• public: Static assets accessible to the public.
• state: State management code, such as Redux reducers and actions.
• types: Custom type definitions used in the project.
• app/generate: Code related to generating or scaffolding new files or components.
• components/ui: UI-specific components used in the application.
• app/generate: Code related to generating or scaffolding new files or components.
• app/generate: Code related to generating or scaffolding new files or components.

💻 Stack

• axios: Promise-based HTTP client for making API requests.
• next: React framework for building server-rendered applications.
• react: JavaScript library for building user interfaces.
• react-dom: Package for rendering React components in the browser.
• react-icons: Collection of popular icons as React components.
• tailwindcss: Utility-first CSS framework for quickly building custom designs.
• zustand: Small and fast state management library for React.
• typescript: Typed superset of JavaScript that compiles to plain JavaScript.

🚀 Run Locally

1.Clone the filestruct-rust repository:

git clone https://github.com/codescalper/filestruct-rust

2.Install the dependencies with one of the package managers listed below:

npm install

3.Start the development mode:

npm run dev

🙌 Contributors