https://github.com/eshanized/preadme
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.
https://github.com/eshanized/preadme
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
Last synced: 7 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/eshanized/preadme
- Owner: eshanized
- Created: 2024-12-27T21:36:04.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-02-10T17:26:16.000Z (8 months ago)
- Last Synced: 2025-02-10T17:31:22.945Z (8 months ago)
- 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
- Language: TypeScript
- Homepage: https://eshanized.github.io/preadme/
- Size: 1.02 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Readme
[](https://opensource.org/licenses/MIT)
[](https://github.com/eshanized/project-readme/releases)
[](https://github.com/eshanized/project-readme/actions)
[](https://david-dm.org/eshanized/project-readme)
[](https://github.com/prettier/prettier)
[](http://makeapullrequest.com)
Project 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.
### 🎯 Key Features
- **Interactive Editor**
- Real-time Markdown preview
- Syntax highlighting
- Keyboard shortcuts
- Auto-save functionality
- **Rich Content Support**
- Tables with alignment options
- Code blocks with syntax highlighting
- Image uploads and embedding
- Task lists and checkboxes
- **Templates & Customization**
- Pre-built templates for different project types
- Custom section ordering
- Dark/Light theme support
- Responsive design for all devices
- **Export Options**
- Download as Markdown (.md)
- Copy to clipboard
- Direct GitHub integration
- HTML export (coming soon)
### 🚀 Demo
Experience Preadme in action: [Live Demo](https://eshanized.github.io/preadme)
### 💻 Tech Stack
- **Frontend Framework**: React 18 with TypeScript
- **State Management**: Zustand
- **Styling**: Tailwind CSS + Nord Theme
- **Markdown Processing**: React Markdown + Remark
- **Build Tool**: Vite
- **Package Manager**: npm
- **Code Quality**: ESLint + Prettier
- **Testing**: Jest + React Testing Library (coming soon)
### ⚡ Performance
- Lighthouse Score: 95+ across all metrics
- First Contentful Paint: < 1s
- Time to Interactive: < 2s
- Bundle Size: < 200KB (gzipped)
### 🌐 Browser Support
- Chrome (last 2 versions)
- Firefox (last 2 versions)
- Safari (last 2 versions)
- Edge (last 2 versions)
- Opera (last 2 versions)
### 📦 Installation
1. Clone the repository:
```bash
git clone https://github.com/eshanized/preadme.git
cd preadme
```
2. Install dependencies:
```bash
npm install
```
3. Start development server:
```bash
npm run dev
```
4. Build for production:
```bash
npm run build
```
### 🔧 Configuration
Create a `.env` file in the root directory:
```env
VITE_APP_TITLE=Preadme
VITE_GITHUB_TOKEN=your_github_token
VITE_API_URL=your_api_url
```
### 🤝 Contributing
1. Fork the repository
2. Create your feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request
#### Contribution Guidelines
- Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
- Write clear commit messages
- Include tests for new features
- Update documentation as needed
- Follow the existing code style
### 🗺️ Development Roadmap
- [ ] GitHub API integration
- [ ] Custom template creation
- [ ] Collaborative editing
- [ ] Export to PDF
- [ ] Multiple language support
- [ ] AI-powered content suggestions
### ❓ Troubleshooting
Common issues and solutions:
1. **Build Errors**
- Clear npm cache: `npm cache clean --force`
- Delete node_modules: `rm -rf node_modules`
- Reinstall dependencies: `npm install`
2. **Runtime Errors**
- Check browser console for errors
- Verify environment variables
- Clear browser cache
### 📈 Statistics
- GitHub Stars: 
- Downloads: 
- Contributors: 
### 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### 🙏 Acknowledgments
- [Nord Theme](https://www.nordtheme.com/) for the color scheme
- [Lucide Icons](https://lucide.dev/) for the beautiful icons
- All our [contributors](https://github.com/eshanized/preadme/graphs/contributors)
### 📞 Support
- Create an [Issue](https://github.com/eshanized/preadme/issues)
- Join our [Discord](https://discord.gg/preadme)
- Follow us on [Twitter](https://twitter.com/preadme)
---
Made with ❤️ by [eshanized](https://github.com/eshanized)