{"id":24521081,"url":"https://github.com/eshanized/preadme","last_synced_at":"2026-04-07T08:01:46.422Z","repository":{"id":270044260,"uuid":"909150848","full_name":"eshanized/preadme","owner":"eshanized","description":"An open-source web application designed to help developers quickly generate well-structured and customizable README files for their projects. Whether you're creating a new project or updating an existing one, Preadme makes it easy to generate a polished README with minimal effort.","archived":false,"fork":false,"pushed_at":"2025-02-10T17:40:57.000Z","size":1732,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-15T12:32:07.834Z","etag":null,"topics":["developer-productivity","developer-tools","github-readme","markdown","open-source","project-documentation","react","react-markdown","readme-builder","readme-customization","readme-generator","readme-preview","readme-templates","tailwindcss","vite"],"latest_commit_sha":null,"homepage":"https://eshanized.github.io/preadme/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eshanized.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-27T21:36:04.000Z","updated_at":"2025-02-10T17:40:42.000Z","dependencies_parsed_at":"2024-12-28T00:22:40.444Z","dependency_job_id":"f85a1956-5059-4174-a065-daee9df926f9","html_url":"https://github.com/eshanized/preadme","commit_stats":null,"previous_names":["eshanized/preadme"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eshanized/preadme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshanized%2Fpreadme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshanized%2Fpreadme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshanized%2Fpreadme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshanized%2Fpreadme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eshanized","download_url":"https://codeload.github.com/eshanized/preadme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eshanized%2Fpreadme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31504897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-productivity","developer-tools","github-readme","markdown","open-source","project-documentation","react","react-markdown","readme-builder","readme-customization","readme-generator","readme-preview","readme-templates","tailwindcss","vite"],"created_at":"2025-01-22T02:48:56.007Z","updated_at":"2026-04-07T08:01:46.404Z","avatar_url":"https://github.com/eshanized.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project Readme\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![GitHub release](https://img.shields.io/github/release/eshanized/project-readme.svg)](https://github.com/eshanized/project-readme/releases)\n[![Build Status](https://github.com/eshanized/project-readme/workflows/build/badge.svg)](https://github.com/eshanized/project-readme/actions)\n[![Dependencies](https://img.shields.io/david/eshanized/project-readme.svg)](https://david-dm.org/eshanized/project-readme)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)\n\nProject Readme is a modern, feature-rich README generator built with React and TypeScript. Create professional documentation for your projects with an intuitive interface and powerful features.\n\n### 🎯 Key Features\n\n- **Interactive Editor**\n  - Real-time Markdown preview\n  - Syntax highlighting\n  - Keyboard shortcuts\n  - Auto-save functionality\n\n- **Rich Content Support**\n  - Tables with alignment options\n  - Code blocks with syntax highlighting\n  - Image uploads and embedding\n  - Task lists and checkboxes\n\n- **Templates \u0026 Customization**\n  - Pre-built templates for different project types\n  - Custom section ordering\n  - Dark/Light theme support\n  - Responsive design for all devices\n\n- **Export Options**\n  - Download as Markdown (.md)\n  - Copy to clipboard\n  - Direct GitHub integration\n  - HTML export (coming soon)\n\n### 🚀 Demo\n\nExperience Preadme in action: [Live Demo](https://eshanized.github.io/preadme)\n\n### 💻 Tech Stack\n\n- **Frontend Framework**: React 18 with TypeScript\n- **State Management**: Zustand\n- **Styling**: Tailwind CSS + Nord Theme\n- **Markdown Processing**: React Markdown + Remark\n- **Build Tool**: Vite\n- **Package Manager**: npm\n- **Code Quality**: ESLint + Prettier\n- **Testing**: Jest + React Testing Library (coming soon)\n\n### ⚡ Performance\n\n- Lighthouse Score: 95+ across all metrics\n- First Contentful Paint: \u003c 1s\n- Time to Interactive: \u003c 2s\n- Bundle Size: \u003c 200KB (gzipped)\n\n### 🌐 Browser Support\n\n- Chrome (last 2 versions)\n- Firefox (last 2 versions)\n- Safari (last 2 versions)\n- Edge (last 2 versions)\n- Opera (last 2 versions)\n\n### 📦 Installation\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/eshanized/preadme.git\n   cd preadme\n   ```\n\n2. Install dependencies:\n   ```bash\n   npm install\n   ```\n\n3. Start development server:\n   ```bash\n   npm run dev\n   ```\n\n4. Build for production:\n   ```bash\n   npm run build\n   ```\n\n### 🔧 Configuration\n\nCreate a `.env` file in the root directory:\n```env\nVITE_APP_TITLE=Preadme\nVITE_GITHUB_TOKEN=your_github_token\nVITE_API_URL=your_api_url\n```\n\n### 🤝 Contributing\n\n1. Fork the repository\n2. Create your feature branch: `git checkout -b feature/amazing-feature`\n3. Commit your changes: `git commit -m 'Add amazing feature'`\n4. Push to the branch: `git push origin feature/amazing-feature`\n5. Open a Pull Request\n\n#### Contribution Guidelines\n\n- Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification\n- Write clear commit messages\n- Include tests for new features\n- Update documentation as needed\n- Follow the existing code style\n\n### 🗺️ Development Roadmap\n\n- [ ] GitHub API integration\n- [ ] Custom template creation\n- [ ] Collaborative editing\n- [ ] Export to PDF\n- [ ] Multiple language support\n- [ ] AI-powered content suggestions\n\n### ❓ Troubleshooting\n\nCommon issues and solutions:\n\n1. **Build Errors**\n   - Clear npm cache: `npm cache clean --force`\n   - Delete node_modules: `rm -rf node_modules`\n   - Reinstall dependencies: `npm install`\n\n2. **Runtime Errors**\n   - Check browser console for errors\n   - Verify environment variables\n   - Clear browser cache\n\n### 📈 Statistics\n\n- GitHub Stars: ![GitHub stars](https://img.shields.io/github/stars/eshanized/preadme.svg)\n- Downloads: ![npm downloads](https://img.shields.io/npm/dm/preadme.svg)\n- Contributors: ![GitHub contributors](https://img.shields.io/github/contributors/eshanized/preadme.svg)\n\n### 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n### 🙏 Acknowledgments\n\n- [Nord Theme](https://www.nordtheme.com/) for the color scheme\n- [Lucide Icons](https://lucide.dev/) for the beautiful icons\n- All our [contributors](https://github.com/eshanized/preadme/graphs/contributors)\n\n### 📞 Support\n\n- Create an [Issue](https://github.com/eshanized/preadme/issues)\n- Join our [Discord](https://discord.gg/preadme)\n- Follow us on [Twitter](https://twitter.com/preadme)\n\n---\n\nMade with ❤️ by [eshanized](https://github.com/eshanized)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feshanized%2Fpreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feshanized%2Fpreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feshanized%2Fpreadme/lists"}