šØ ASCII Art Generator
š A powerful web application for converting images and text into ASCII art, built with Next.js, React, and Tailwind CSS.
š Table of Contents
š Project Overview
The ASCII Art Generator is a sophisticated web application that transforms images and text into captivating ASCII art. Built with modern web technologies, it offers an intuitive interface with extensive customization options, making it easy for users to create unique ASCII artworks.
Whether you're a digital artist, a programmer looking to add some flair to your console applications, or just someone who appreciates the aesthetic of ASCII art, this tool provides a seamless experience for generating, customizing, and exporting ASCII creations.
⨠Features
š¼ļø Image Processing
- Image to ASCII Conversion: Upload any image and watch it transform into ASCII art in real-time
- Customizable Parameters: Fine-tune your ASCII art with adjustable settings for width, brightness, and contrast
- Real-time Preview: See changes instantly as you adjust settings, allowing for quick iterations
š Text Conversion
- Text to ASCII Art: Convert any text input into stylized ASCII art
- Multiple Character Sets: Choose from various character sets to achieve different visual styles
- Preset Styles: Quick access to predefined styles for instant artistic effects
šÆ User Interface
- Dark/Light Theme: Toggle between dark and light modes for comfortable viewing
- Responsive Design: Fully functional on desktop, tablet, and mobile devices
- Intuitive Controls: User-friendly interface with easy-to-understand settings
š¾ Output Options
- Copy to Clipboard: Instantly copy your ASCII art for quick sharing
- Download as Text File: Save your creation as a .txt file
- Re-upload Functionality: Load previously generated ASCII art for further editing
šļø Architecture
š ļø Technology Stack
- Next.js: Server-side rendering and efficient routing
- React: Dynamic and responsive user interface components
- Tailwind CSS: Utility-first CSS for rapid UI development
- TypeScript: Type safety and enhanced code quality
š Design Pattern
The application implements a component-based architecture, separating client-side and server-side logic for:
- Modular and reusable code
- Efficient state management
- Optimized performance
š Installation
Clone the repository:
git clone https://github.com/yllvar/create-ascii-art.git
cd create-ascii-art
Install dependencies:
npm install
Set up environment variables:
- Copy
.env.example
to .env.local
- Fill in required variables
Run the development server:
npm run dev
Open http://localhost:3000 in your browser š
š Usage
š¼ļø Converting an Image to ASCII
- Click "Upload Image" in the sidebar
- Select an image file
- Adjust width, brightness, and contrast
- Watch your ASCII art update in real-time
āļø Creating ASCII Art from Text
- Switch to the "Text" tab
- Enter your text
- Select character set and style
- Click "Generate"
šØ Customizing Your ASCII Art
- Try different presets
- Fine-tune using advanced settings
- Toggle dark/light mode as needed
š¾ Exporting Your Creation
- Copy to clipboard with one click
- Download as a text file
- Save for later editing
š¤ Contributing
We welcome contributions! Here's how:
- Fork the repository
- Create a new branch:
git checkout -b feature/amazing-feature
- Commit your changes:
git commit -m 'Add amazing feature'
- Push to the branch:
git push origin feature/amazing-feature
- Open a pull request š
Please read CONTRIBUTING.md for details on our code of conduct.
š License
This project is licensed under the MIT License - see LICENSE.md for details.
š Found a bug? Have a feature request? Open an issue