Welcome to FileGen
FileGen is a powerful and flexible file generation tool designed to streamline your development workflow. Create project structures, boilerplate code, and custom templates with ease.
To install FileGen, run the following command:
npm install -g filegenQuick Setup
Get started in minutes with our simple installation process.
Customizable Templates
Create and use your own templates or choose from our pre-defined options.
Installation
Get started with FileGen by installing it globally on your system.
Install FileGen globally
Install FileGen as a global package using your preferred package manager
npm install -g filegennpm Package Information
Details about the FileGen npm package
Usage
Learn how to use FileGen to generate file structures for your projects.
Run the interactive CLI
Use the command-line interface to select templates interactively
filegenSpecify a template directly
Generate files for a specific template without interaction
filegen --template e-commerce🎯 Interactive Selection
When you run filegen without any arguments, you'll be presented with an interactive CLI interface:
How to use
Navigate and select templates using keyboard controls
1. Template Selection
Select a template to generate:
▶ 🛒 E-commerce Store
✍️ Blog Platform
💻 Tech Website
📁 Portfolio
🚀 SaaS Platform
👥 Community Forum
📚 Learning Management System
📰 News Portal
[↑↓] Navigate
[Enter] Select template
2. Package Manager Selection
Choose a package manager to use:
▶ bunx
npx
yarn
pnpm
3. Project Setup
- Creates a new Next.js project with:
- TypeScript configuration
- Tailwind CSS setup
- ESLint integration
- Installs template-specific dependencies
- Generates the file structure based on your selected template
4. Post-Installation
Once completed, you can start your development server:
# Start the development server
bun dev
# or
npm run dev
# or
yarn dev
# or
pnpm dev
Available Templates
Explore the pre-defined templates available in FileGen.
E-commerce Store
- Complete shopping cart
- Product management
- State management with Zustand
- TypeScript support
Blog Platform
- Featured posts section
- Dynamic routing
- Author profiles
- Responsive design
Tech Website
- Modern landing page
- Feature showcase
- Contact forms
- SEO optimized
Portfolio
- Project showcase
- Skills section
- Contact information
- Responsive design
SaaS Platform
- Authentication
- Dashboard
- User management
- Subscription handling
Community Forum
- Discussion boards
- User profiles
- Notifications
- Search functionality
Learning Management
- Course structure
- Progress tracking
- Assessments
- User dashboard
News Portal
- Article layout
- Categories
- Search functionality
- Responsive design
FileGen AI Chat
FileGen uses a simple syntax to generate project structures with Filegen AI Chat:
@filegen/[ProjectType]Replace [ProjectType] with: blog, ecommerce, or portfolio etc.
Features
Automatic Dependencies
- • Next.js 14^
- • React 18
- • TypeScript
- • TailwindCSS
Project Structure
- • Feature-based organization
- • Modern Next.js app directory
- • API routes included
- • Common utilities
Example Usage
const response = await fetch('/api/generate', {
method: 'POST',
body: JSON.stringify({
request: '@filegen/blog'
})
});Response Structure
{
structure: string, // Generated file structure
packageJson: string, // Package.json content
copyCommand: string // Next.js creation command
}Next.js Integration
npx create-next-app@latest [project-name] --typescript --tailwind --eslint --app --src-dir --import-alias "@/*"Best Practices
- 1. Always check the generated structure before implementing
- 2. Review and adjust dependencies as needed
- 3. Follow the provided file organization patterns
- 4. Use the provided configuration files as a starting point
License
Information about the license under which FileGen is distributed.
License
A permissive open-source license
FileGen is released under the MIT License. You are free to use, modify, and distribute this software, subject to the terms of the license.