https://github.com/rafat-alam/mdx-editor
MDX Editor is a modern platform for creating and organizing .mdx documents with AI-assisted writing, live preview, and folder management for dynamic, interactive content.
https://github.com/rafat-alam/mdx-editor
nextjs postgresql redux-tookit tailwindcss typescript
Last synced: 6 months ago
JSON representation
MDX Editor is a modern platform for creating and organizing .mdx documents with AI-assisted writing, live preview, and folder management for dynamic, interactive content.
- Host: GitHub
- URL: https://github.com/rafat-alam/mdx-editor
- Owner: rafat-alam
- License: mit
- Created: 2025-09-07T10:44:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T15:10:31.000Z (6 months ago)
- Last Synced: 2026-01-11T02:06:23.571Z (6 months ago)
- Topics: nextjs, postgresql, redux-tookit, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://mdx-e.vercel.app
- Size: 3.36 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# MDX Editor 🚀📝
**MDX Editor** is a powerful and intuitive platform built to help you **create, organize, and share knowledge** effortlessly ✨. Whether you’re writing technical documentation, learning notes, or community guides, MDX Editor gives you everything you need in one place 📚.
## Why MDX Editor? ✨💡
* 📁 **Structured Repositories**
Organize your content using folders and MDX files 📂. Treat folders as main topics and files as subtopics to maintain a clean, logical hierarchy 🧠.
* ✍️ **Rich MDX Editing with Live Preview**
Write Markdown, JSX, and code blocks with real-time previews 👀, so you always see exactly what you’re building ⚡.
* 🤖 **AI-Powered Content Generation (RAG)**
Generate accurate and up-to-date documentation using 🧠✨:
* 📚 Repository-wide context
* 🌐 Web crawling for fresh information
* 🔗 URL-based trusted sources
* ⚡ LLM-only generation for quick drafts
* 🛠️ **Smart Content Refinement**
Improve clarity, structure, and accuracy with AI-assisted refinements ✨. Enhance specific sections without rewriting the entire document 🧹.
* 🌍 **Share with the Community**
Publish repositories publicly to help others learn 🤝, or keep them private for personal or internal use 🔒.
* 🎓 **Learn by Exploring**
Browse public repositories 📖, view combined topics 🧩, and get inspired by community-driven knowledge 🌟.
## Built for Everyone 💡👥
* 👨💻 Developers & engineers
* 🎒 Students & learners
* ✍️ Writers & educators
* 🧑🤝🧑 Teams building internal documentation
**Free to use 🆓, easy to get started 🚀, and powerful as you grow 📈**, MDX Editor transforms ideas into **well-structured, shareable documentation**—faster ⚡ and smarter 🧠.
## Future Updates 🔮🛠️
### v2 🌱
1. Profile settings 👤
2. Change name ✏️
3. Change username 🆔
4. Change email 📧
5. Change password 🔒
6. Middleware to Proxy 🧩
7. OAuth SignIn / SignUp 🔑
8. Connect RAG 🤖
### v3
1. Connect GPT
## Project Structure 🗂️
```
db/
├── index.ts (function to get _db instance)
└── schema.ts
public/
└── team/ (team profile pictures)
src/
├── app/
│ ├── about (page)
│ │
│ ├── api
│ │ ├── ai
│ │ │ ├── gemini (route)
│ │ │ └── gpt (route) (Comming Soon...)
│ │ │
│ │ ├── auth
│ │ │ ├── [...nextauth] (route)
│ │ │ ├── forgot-pass (route)
│ │ │ └── signup (route)
│ │ │
│ │ ├── edit
│ │ │ ├── add-file (route)
│ │ │ ├── add-folder (route)
│ │ │ ├── add-repo (route)
│ │ │ ├── remove (route)
│ │ │ ├── rename (route)
│ │ │ ├── save (route)
│ │ │ └── set-repo-vis (route)
│ │ │
│ │ ├── get
│ │ │ ├── all-public-repos (route)
│ │ │ └── path (route)
│ │ │
│ │ ├── rag
│ │ │ ├── repo (route) (Comming Soon...)
│ │ │ ├── url (route) (Comming Soon...)
│ │ │ └── web (route) (Comming Soon...)
│ │ │
│ │ └── u/[username] (route)
│ │
│ ├── editor (page)
│ ├── forgot-pass (page)
│ ├── public-repos (page)
│ ├── settings (page)
│ ├── signin (page)
│ └── u/[...path] (page)
│
├── components
│ ├── about
│ ├── dashboard
│ ├── editor
│ ├── forgot-pass
│ ├── home
│ ├── nav-menu
│ ├── public-repos
│ ├── signin
│ ├── signup
│ ├── ui
│ ├── ui2
│ └── themeprovider
│
├── data/
│ └── team_members_data.json
│
├── lib/
│ └── utils.ts
│
├── module/
│ ├── entities/
│ │ ├── node.ts
│ │ └── user.ts
│ │
│ ├── repo/
│ │ ├── node_repo.ts
│ │ └── user_repo.ts
│ │
│ └── services/
│ ├── auth_service.ts
│ ├── helper_service.ts
│ ├── node_service.ts
│ └── user_service.ts
│
├── store/ (Redux Toolkit)
│ ├── authSlice.ts
│ └── store.ts
│
└── middleware.ts (Edge Runtime)
types/
└── next-auth.d.ts
```
## API Flow 🔁🧠
```
Client (UI / Fetch / Axios)
↓
Middleware (Edge)
- coarse authentication gate (logged in or not)
- protected route allow/deny
- lightweight session existence check
↓
API Route (Controller)
- full authentication check (authoritative)
- input validation
- data normalization
↓
Service (Business Logic)
- permissions (ownership, roles)
- workflows
- transactions
- orchestration
↓
Repository (Data Access)
- database queries only
↓
Database
```
## Local Development Setup 🧑💻⚙️
### Clone Repository 📦
```bash
git clone https://github.com/rafat-alam/mdx-editor.git
cd mdx-editor
```
### Create `.env` File 🔐
```env
# Database connection string
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DB_NAME?sslmode=require"
# NextAuth secret key
NEXTAUTH_SECRET="your_nextauth_secret_here"
# SMTP (Brevo) credentials
BRAVO_USER="your_brevo_username_here"
BRAVO_PASS="your_brevo_password_here"
# Gemini API key
GEMINI_API_KEY="your_gemini_api_key_here"
# Upstash (Redis API)
UPSTASH_REDIS_REST_URL="https://user-redis-0000.upstash.io"
UPSTASH_REDIS_REST_TOKEN="upstash_redis_rest_token_here"
```
### Install Dependencies 📥
```bash
npm install
```
### Run Drizzle ORM (First Time Only) 🗄️
```bash
npx drizzle-kit generate
npx drizzle-kit migrate
```
### Run Project (Development) ⚡
```bash
npm run dev
```
### Run Project (Production) 🚀
```bash
npm run build
npm run start
```
## License (MIT) 📜✅
```
MIT License
Copyright (c) 2025 Rafat Alam
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
---