poyrazavsever / readme-maker

Welcome to the GitHub README Maker! This application allows you to generate professional and customizable README files for your GitHub projects. Built with **Next.js** and **Redux**, it offers a user-friendly interface to help you create and manage your README content with ease.

GitHub README Maker

Welcome to the GitHub README Maker! This application allows you to generate professional and customizable README files for your GitHub projects. Built with Next.js and Redux, it offers a user-friendly interface to help you create and manage your README content with ease.

Features

• 📝 Customizable Templates: Choose from various templates to suit your project's needs.
• ✨ Live Preview: See changes in real-time as you edit your README.
• 💾 Save and Export: Save your README locally or export it to your GitHub repository.
• 🌟 User-Friendly Interface: Built with Next.js for a smooth user experience and Redux for state management.

Technologies Used

• Next.js: A React framework for server-side rendering and static site generation.
• Redux: A state management library to handle application state.
• React: For building the user interface.
• Tailwind CSS: For modern and responsive styling.

Getting Started

To get started with the project, follow these steps:

Prerequisites

Ensure you have Node.js and npm installed.

Installation

1. Clone the repository:

   git clone https://github.com/poyrazavsever/readme-maker.git
   cd readme-maker

2. Install dependencies:

   npm install

Running the App

Start the development server:

npm run dev