Readme Maker
Readme Maker is a modern web application that helps you create professional README files for your GitHub projects. With its drag-and-drop interface, customizable templates, and real-time preview, it simplifies and accelerates the process of writing READMEs.
About
Readme Maker is a user-friendly tool designed to help developers present their projects in the best way possible. Features:
- Customizable Templates: Predefined templates for different project types
- Live Preview: Instantly view your changes
- Responsive Design: Works perfectly on all devices
- Multi-language Support: Language options in TR/EN
- Theme Support: Light/Dark theme options
Technologies Used
Frontend
| Technology | Description | Icon |
|---|---|---|
| React | JavaScript library for modern user interfaces | |
| Next.js | React-based web framework with SSR support | |
| Tailwind CSS | Utility-first CSS framework | |
| TypeScript | Type-safe superset of JavaScript |
State Management and Tools
| Technology | Description | Icon |
|---|---|---|
| Redux Toolkit | Modern state management with Redux | |
| React-Markdown | Markdown rendering tool |
Features
Template Selection
- Specialized templates for various project types
- Customizable sections
- Ready-made markdown structures
Live Preview
- Real-time preview
- GitHub-style rendering
- Responsive layout check
Export
- Copy in Markdown or HTML formats
Installation and Usage
# Clone the repository
git clone https://github.com/poyrazavsever/readme-maker.git
# Navigate to the project directory
cd readme-maker
# Install dependencies
npm install
# Start the development server
npm run dev
Project Development Timeline
Planning & Design (3 Weeks)
- UX research
- UI/UX design
- Technology stack selection
Core Development (1 Week)
- Component architecture setup
- Markdown rendering system
Contributing
To contribute to this project:
- Fork this repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Create a Pull Request
Useful Links
- Live Demo: https://readme-maker-eight.vercel.app/
- GitHub Repo: https://github.com/poyrazavsever/readme-maker
- Issue Tracker: https://github.com/poyrazavsever/readme-maker/issues
Developer
Poyraz Avsever - https://github.com/poyrazavsever
This project is open-source under the MIT license.