{"id":31578358,"url":"https://github.com/sayeedmunees/mdme-frontend","last_synced_at":"2026-04-02T03:03:05.475Z","repository":{"id":317682773,"uuid":"1068388464","full_name":"sayeedmunees/mdme-frontend","owner":"sayeedmunees","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-02T11:13:14.000Z","size":301,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-02T12:35:22.201Z","etag":null,"topics":["css","css3","editor","html","javascript","json-server","markdown","markdownmadeeasy","mdme","react","react-router","reactjs"],"latest_commit_sha":null,"homepage":"https://mdme.vercel.app","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sayeedmunees.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-02T10:02:59.000Z","updated_at":"2025-10-02T11:15:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"aaa6feea-149d-4e4d-815a-518af3470d12","html_url":"https://github.com/sayeedmunees/mdme-frontend","commit_stats":null,"previous_names":["sayeedmunees/mdme-frontend"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/sayeedmunees/mdme-frontend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeedmunees%2Fmdme-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeedmunees%2Fmdme-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeedmunees%2Fmdme-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeedmunees%2Fmdme-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sayeedmunees","download_url":"https://codeload.github.com/sayeedmunees/mdme-frontend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sayeedmunees%2Fmdme-frontend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31294827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T01:43:37.129Z","status":"online","status_checked_at":"2026-04-02T02:00:08.535Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["css","css3","editor","html","javascript","json-server","markdown","markdownmadeeasy","mdme","react","react-router","reactjs"],"created_at":"2025-10-05T19:57:08.299Z","updated_at":"2026-04-02T03:03:05.426Z","avatar_url":"https://github.com/sayeedmunees.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MDME - Mark Down Made Easy 📝\n\n![MDME Banner](https://img.shields.io/badge/MDME-Mark%20Down%20Made%20Easy-blue?style=for-the-badge)\n![Open Source](https://img.shields.io/badge/Open%20Source-Yes-green?style=for-the-badge)\n![License](https://img.shields.io/badge/License-MIT-yellow?style=for-the-badge)\n![Contributions](https://img.shields.io/badge/Contributions-Welcome-orange?style=for-the-badge)\n\n\nA modern, open-source markdown editor with AI integration capabilities. MDME (Mark Down Made Easy) provides a clean, intuitive interface for writing and editing markdown with real-time preview functionality.\n\n## 🌐 Live Demo\n\n**[Try MDME →](https://mdme.vercel.app/)**\n\n## 📂 Repositories\n\n- **Frontend**: [mdme-frontend](https://github.com/sayeedmunees/mdme-frontend) (This Repository)\n- **Backend**: [mdme-backend](https://github.com/sayeedmunees/mdme-backend)\n\n## 🎯 Project Vision\n\nMDME aims to revolutionize the markdown editing experience by combining simplicity with powerful AI-driven features. Our goal is to create an editor that makes markdown accessible to everyone while providing advanced capabilities for power users.\n\n## ✨ Current Features\n\n- **Live Preview**: See your markdown render in real-time as you type\n- **Clean Interface**: Distraction-free writing with minimal design focused on your content\n- **Responsive Design**: Write anywhere on desktop, tablet, or mobile devices seamlessly\n- **Document Management**: Save, edit, and manage your markdown documents\n- **Document History**: Track and access your previously saved documents\n- **Copy \u0026 Export**: Easy content management with copy functionality\n- **GitHub Flavored Markdown**: Full support for enhanced markdown syntax including code blocks, tables, and more\n\n## 🚀 Upcoming AI Features\n\nWe're actively working on integrating AI capabilities to enhance your markdown writing experience:\n\n- **AI Writing Assistant**: Smart writing suggestions and improvements\n- **Content Enhancement**: AI-powered grammar and style suggestions\n- **Auto-completion**: Intelligent markdown syntax completion\n- **Content Optimization**: SEO and readability improvements\n- **Smart Formatting**: Automatic formatting suggestions\n- **Content Generation**: AI-powered content creation assistance\n\n## 🛠️ Tech Stack\n\n### Frontend\n- **React** with Vite for fast development\n- **Modern JavaScript/ES6+**\n- **CSS3** with responsive design\n- **@uiw/react-markdown-editor** for enhanced markdown editing experience\n\n### Backend\n- **Node.js** with Express-like architecture\n- **JSON Server** for RESTful API (current implementation)\n- **CORS** enabled for cross-origin requests\n- **File-based storage** with JSON database (db.json)\n\n### Current API Endpoints\n```\nGET    /markdown     - Retrieve all documents\nPOST   /markdown     - Create new document\nPUT    /markdown/:id - Update existing document\nDELETE /markdown/:id - Delete document\n```\n\n## 🏗️ Project Structure\n\n### Frontend Structure\n```\nmdme-frontend/\n├── src/\n│   ├── components/\n│   │   ├── Editor/\n│   │   ├── Preview/\n│   │   ├── Navigation/\n│   │   └── History/\n│   ├── pages/\n│   │   ├── Home/\n│   │   ├── Editor/\n│   │   └── History/\n│   ├── styles/\n│   └── utils/\n├── public/\n└── README.md\n```\n\n### Backend Structure\n```\nmdme-backend/\n├── index.js          # Main server file\n├── db.json           # JSON database\n├── package.json      # Dependencies\n└── node_modules/     # Installed packages\n```\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- Node.js (v18+ recommended)\n- npm or yarn\n- Git\n\n### Setup Frontend\n\n1. **Clone the frontend repository**\n   ```bash\n   git clone https://github.com/sayeedmunees/mdme-frontend.git\n   cd mdme-frontend\n   ```\n\n2. **Install dependencies**\n   ```bash\n   npm install\n   # or\n   yarn install\n   ```\n\n3. **Start the development server**\n   ```bash\n   npm run dev\n   # or\n   yarn dev\n   ```\n\n4. **Open your browser**\n   ```\n   http://localhost:5173\n   ```\n\n### Setup Backend\n\n1. **Clone the backend repository**\n   ```bash\n   git clone https://github.com/sayeedmunees/mdme-backend.git\n   cd mdme-backend\n   ```\n\n2. **Install dependencies**\n   ```bash\n   npm install\n   ```\n\n3. **Start the backend server**\n   ```bash\n   npm start\n   ```\n\n4. **Backend will be running on**\n   ```\n   http://localhost:3000\n   ```\n\n### Full Stack Development\n\nFor full stack development, run both frontend and backend servers simultaneously:\n\n```bash\n# Terminal 1 - Backend\ncd mdme-backend\nnpm start\n\n# Terminal 2 - Frontend  \ncd mdme-frontend\nnpm run dev\n```\n\n## 🤝 Contributing\n\nWe welcome contributions from developers of all skill levels! MDME is completely open source, and we encourage the community to help shape its future.\n\n### Ways to Contribute\n\n- **Frontend Development**: Improve UI/UX, add new features, enhance editor functionality\n- **Backend Development**: Improve API design, add database integration, enhance performance\n- **AI Integration**: Implement intelligent writing features, content suggestions\n- **Documentation**: Help improve our docs, guides, and tutorials\n- **Bug Reports**: Report issues and suggest improvements\n- **Feature Requests**: Propose new functionality\n- **Testing**: Help test new features and report bugs\n- **Design**: Contribute to UI/UX improvements\n\n### Priority Areas for Contribution\n\n1. **AI Integration**: Implement OpenAI/GPT integration for writing assistance\n2. **Database Migration**: Replace JSON Server with proper database (MongoDB/PostgreSQL)\n3. **User Authentication**: Add user accounts and document ownership\n4. **Real-time Collaboration**: Enable collaborative editing features\n5. **Enhanced Editor**: Add more markdown editing features (tables, math equations)\n6. **Export Options**: PDF, HTML, and other format exports\n7. **Themes**: Dark/light mode and custom themes\n\n### Getting Started with Contributions\n\n1. **Fork both repositories** (frontend and backend)\n2. **Create your feature branch**\n   ```bash\n   git checkout -b feature/amazing-feature\n   ```\n3. **Make your changes and commit**\n   ```bash\n   git commit -m 'Add some amazing feature'\n   ```\n4. **Push to the branch**\n   ```bash\n   git push origin feature/amazing-feature\n   ```\n5. **Open a Pull Request** on the respective repository\n\n### Development Guidelines\n\n- Follow existing code style and conventions\n- Write clear, descriptive commit messages\n- Add comments for complex logic\n- Test your changes thoroughly\n- Update documentation as needed\n- Ensure both frontend and backend work together seamlessly\n\n## 📋 Roadmap\n\n### Phase 1 (Current) - Core Foundation ✅\n- [x] Basic markdown editor with live preview\n- [x] Document saving and history\n- [x] Responsive design\n- [x] RESTful API with JSON Server\n- [x] CORS enabled backend\n- [ ] Theme switching (dark/light)\n- [ ] Enhanced export functionality\n\n### Phase 2 - AI Integration 🚧\n- [ ] OpenAI/GPT integration\n- [ ] AI writing assistant\n- [ ] Smart auto-completion\n- [ ] Grammar and style suggestions\n- [ ] Content optimization\n- [ ] Intelligent formatting\n\n### Phase 3 - Enhanced Backend 📋\n- [ ] Database migration (MongoDB/PostgreSQL)\n- [ ] User authentication system\n- [ ] Document ownership and sharing\n- [ ] Advanced API features\n- [ ] Cloud storage integration\n\n### Phase 4 - Advanced Features 🔮\n- [ ] Real-time collaborative editing\n- [ ] Plugin system architecture\n- [ ] Advanced export options (PDF, HTML, LaTeX)\n- [ ] Version control integration\n- [ ] Template system\n\n### Phase 5 - Enterprise Features 🏢\n- [ ] Team workspaces\n- [ ] Advanced analytics\n- [ ] Custom AI models\n- [ ] Enterprise security features\n- [ ] On-premise deployment options\n\n## 🐛 Issues \u0026 Support\n\nFound a bug or have a feature request? We'd love to hear from you!\n\n- **Bug Reports**: [Frontend Issues](https://github.com/sayeedmunees/mdme-frontend/issues) | [Backend Issues](https://github.com/sayeedmunees/mdme-backend/issues)\n- **Feature Requests**: Open an issue in the relevant repository\n- **General Discussion**: Start a discussion in either repository\n- **Questions**: Feel free to open an issue with the \"question\" label\n\n## 📊 Current Architecture\n\n```\n┌─────────────────┐       ┌─────────────────┐\n│                 │       │                 │\n│   React Frontend│◄─────►│  JSON Server    │\n│   (Port 5173)   │       │  Backend        │\n│                 │       │  (Port 3000)    │\n└─────────────────┘       └─────────────────┘\n                                   │\n                          ┌─────────────────┐\n                          │                 │\n                          │   db.json       │\n                          │   (File DB)     │\n                          │                 │\n                          └─────────────────┘\n```\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 👨‍💻 Author\n\n**Sayeed Munees**\n- GitHub: [@sayeedmunees](https://github.com/sayeedmunees)\n- LinkedIn: [Connect with me](https://linkedin.com/in/sayeedmunees)\n- Project: [MDME Live Demo](https://mdme.vercel.app/)\n\n## 🙏 Acknowledgments\n\n- Thanks to all contributors who help make MDME better\n- Inspired by popular markdown editors and modern development practices\n- Built with love for the open-source community\n- Special thanks to the React and Node.js communities\n\n## 🌟 Show Your Support\n\nIf you find MDME useful, please consider:\n- ⭐ Starring both repositories ([Frontend](https://github.com/sayeedmunees/mdme-frontend) \u0026 [Backend](https://github.com/sayeedmunees/mdme-backend))\n- 🍴 Forking and contributing to the project\n- 📢 Sharing with your network and fellow developers\n- 💬 Providing feedback and feature suggestions\n- 🐛 Reporting bugs to help us improve\n\n## 🔗 Quick Links\n\n- 🌐 **Live Demo**: [mdme.vercel.app](https://mdme.vercel.app/)\n- 📂 **Frontend Repo**: [mdme-frontend](https://github.com/sayeedmunees/mdme-frontend)\n- 🔧 **Backend Repo**: [mdme-backend](https://github.com/sayeedmunees/mdme-backend)\n- 📝 **Try Editor**: [mdme.vercel.app/editor](https://mdme.vercel.app/editor)\n- 📚 **Document History**: [mdme.vercel.app/history](https://mdme.vercel.app/history)\n\n---\n\n**Ready to make markdown easy? [Start editing now →](https://mdme.vercel.app)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayeedmunees%2Fmdme-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsayeedmunees%2Fmdme-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsayeedmunees%2Fmdme-frontend/lists"}