forked from minzeyaphyo/burmddit
Initial Burmddit deployment - AI news aggregator in Burmese
This commit is contained in:
Zeya Phyo
404
README.md
Normal file
404
README.md
Normal file
@@ -0,0 +1,404 @@
|
||||
# Burmddit - Myanmar AI News & Tutorials Platform
|
||||
## Automated AI Content in Burmese
|
||||
|
||||
**Live Site:** burmddit.vercel.app (will be deployed)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 What is Burmddit?
|
||||
|
||||
Burmddit automatically aggregates AI content from top sources, compiles related articles, translates to Burmese, and publishes 10 high-quality articles daily.
|
||||
|
||||
**Content Categories:**
|
||||
- 📰 **AI News** - Latest industry updates, breaking news
|
||||
- 📚 **AI Tutorials** - Step-by-step guides, how-tos
|
||||
- 💡 **Tips & Tricks** - Productivity hacks, best practices
|
||||
- 🚀 **Upcoming Releases** - New models, tools, products
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
### Frontend (Next.js)
|
||||
- Modern, fast, SEO-optimized
|
||||
- Burmese Unicode support
|
||||
- Responsive design
|
||||
- Deployed on Vercel (free)
|
||||
|
||||
### Backend (Python)
|
||||
- Web scraping (Medium, TechCrunch, AI blogs)
|
||||
- Content clustering & compilation
|
||||
- AI-powered Burmese translation (Claude API)
|
||||
- Automated publishing (10 articles/day)
|
||||
- Deployed on Railway ($5/mo)
|
||||
|
||||
### Database (PostgreSQL)
|
||||
- Article storage & metadata
|
||||
- Category management
|
||||
- Analytics tracking
|
||||
- Hosted on Railway
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Prerequisites
|
||||
1. **Vercel Account** - vercel.com (free)
|
||||
2. **Railway Account** - railway.app ($5/mo or free tier)
|
||||
3. **Claude API Key** - console.anthropic.com ($50-100/mo)
|
||||
4. **GitHub Account** - github.com (free)
|
||||
|
||||
### Setup Time: ~15 minutes
|
||||
|
||||
---
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
### 1. Clone & Deploy Frontend
|
||||
|
||||
```bash
|
||||
# Fork this repo to your GitHub
|
||||
|
||||
# Deploy to Vercel (one-click)
|
||||
1. Go to vercel.com/new
|
||||
2. Import your GitHub repo
|
||||
3. Click "Deploy"
|
||||
4. Done! Gets burmddit.vercel.app URL
|
||||
```
|
||||
|
||||
### 2. Deploy Backend
|
||||
|
||||
```bash
|
||||
# On Railway:
|
||||
1. Create new project
|
||||
2. Add PostgreSQL database
|
||||
3. Deploy Python service (from /backend folder)
|
||||
4. Set environment variables (see below)
|
||||
```
|
||||
|
||||
### 3. Environment Variables
|
||||
|
||||
**Frontend (.env.local):**
|
||||
```env
|
||||
DATABASE_URL=your_railway_postgres_url
|
||||
NEXT_PUBLIC_SITE_URL=https://burmddit.vercel.app
|
||||
```
|
||||
|
||||
**Backend (.env):**
|
||||
```env
|
||||
DATABASE_URL=your_railway_postgres_url
|
||||
ANTHROPIC_API_KEY=your_claude_api_key
|
||||
ADMIN_PASSWORD=your_secure_password
|
||||
```
|
||||
|
||||
### 4. Initialize Database
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python init_db.py
|
||||
```
|
||||
|
||||
### 5. Start Automation
|
||||
|
||||
```bash
|
||||
# Runs daily at 6 AM UTC via GitHub Actions
|
||||
# Or manually trigger:
|
||||
cd backend
|
||||
python run_pipeline.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
burmddit/
|
||||
├── frontend/ # Next.js website
|
||||
│ ├── app/ # App router pages
|
||||
│ │ ├── page.tsx # Homepage
|
||||
│ │ ├── [slug]/ # Article pages
|
||||
│ │ ├── category/ # Category pages
|
||||
│ │ └── layout.tsx # Root layout
|
||||
│ ├── components/ # React components
|
||||
│ ├── lib/ # Utilities
|
||||
│ └── public/ # Static assets
|
||||
│
|
||||
├── backend/ # Python automation
|
||||
│ ├── scraper.py # Web scraping
|
||||
│ ├── compiler.py # Article compilation
|
||||
│ ├── translator.py # Burmese translation
|
||||
│ ├── publisher.py # Auto-publishing
|
||||
│ ├── run_pipeline.py # Main orchestrator
|
||||
│ └── requirements.txt # Dependencies
|
||||
│
|
||||
├── database/
|
||||
│ └── schema.sql # PostgreSQL schema
|
||||
│
|
||||
├── .github/
|
||||
│ └── workflows/
|
||||
│ └── daily-publish.yml # Automation cron
|
||||
│
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 How It Works
|
||||
|
||||
### Daily Pipeline (Automated)
|
||||
|
||||
**6:00 AM UTC - CRAWL**
|
||||
- Scrapes Medium, TechCrunch, AI news sites
|
||||
- Filters for: AI news, tutorials, tips, releases
|
||||
- Stores raw articles in database
|
||||
|
||||
**7:00 AM - CLUSTER**
|
||||
- Groups similar articles by topic
|
||||
- Identifies 10 major themes
|
||||
- Ranks by relevance & interest
|
||||
|
||||
**8:00 AM - COMPILE**
|
||||
- Merges 3-5 related articles per topic
|
||||
- Extracts key points, quotes, data
|
||||
- Creates comprehensive 800-1200 word articles
|
||||
|
||||
**9:00 AM - TRANSLATE**
|
||||
- Translates to Burmese (Claude 3.5 Sonnet)
|
||||
- Localizes technical terms
|
||||
- Preserves formatting & links
|
||||
|
||||
**10:00 AM - PUBLISH**
|
||||
- Posts to website (1 article/hour)
|
||||
- Generates SEO metadata
|
||||
- Auto-shares on social media (optional)
|
||||
|
||||
---
|
||||
|
||||
## 📊 Content Strategy
|
||||
|
||||
### Target Keywords (Burmese)
|
||||
- AI သတင်းများ (AI news)
|
||||
- AI ကို လေ့လာခြင်း (Learning AI)
|
||||
- ChatGPT မြန်မာ (ChatGPT Myanmar)
|
||||
- AI tools များ (AI tools)
|
||||
|
||||
### Article Types
|
||||
|
||||
**1. AI News (3/day)**
|
||||
- Breaking news compilation
|
||||
- Industry updates
|
||||
- Company announcements
|
||||
|
||||
**2. AI Tutorials (3/day)**
|
||||
- How to use ChatGPT
|
||||
- Prompt engineering guides
|
||||
- AI tool tutorials
|
||||
|
||||
**3. Tips & Tricks (2/day)**
|
||||
- Productivity hacks
|
||||
- Best practices
|
||||
- Tool comparisons
|
||||
|
||||
**4. Upcoming Releases (2/day)**
|
||||
- Model announcements
|
||||
- Tool launches
|
||||
- Event previews
|
||||
|
||||
---
|
||||
|
||||
## 💰 Monetization
|
||||
|
||||
### Phase 1 (Month 1-3)
|
||||
- Google AdSense
|
||||
- Focus on traffic growth
|
||||
|
||||
### Phase 2 (Month 4-6)
|
||||
- Affiliate links (AI tools)
|
||||
- Amazon Associates
|
||||
- Sponsored posts
|
||||
|
||||
### Phase 3 (Month 6+)
|
||||
- Premium newsletter
|
||||
- Courses in Burmese
|
||||
- Consulting services
|
||||
|
||||
**Revenue Target:** $2,000-5,000/month by Month 12
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Website Features
|
||||
|
||||
**Public Pages:**
|
||||
- 🏠 Homepage (latest articles, trending)
|
||||
- 📰 Article pages (clean reading, Burmese fonts)
|
||||
- 🏷️ Category pages (4 categories)
|
||||
- 🔍 Search (Burmese + English)
|
||||
- 📱 Mobile responsive
|
||||
|
||||
**Article Features:**
|
||||
- Beautiful Burmese typography
|
||||
- Code syntax highlighting
|
||||
- Image optimization
|
||||
- Social sharing
|
||||
- Related articles
|
||||
- Reading time estimate
|
||||
|
||||
**Admin Features:**
|
||||
- Content dashboard
|
||||
- Manual editing (optional)
|
||||
- Analytics overview
|
||||
- Pipeline monitoring
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Security & Compliance
|
||||
|
||||
### Content Rights
|
||||
- Articles are compilations of public information
|
||||
- Proper attribution to original sources
|
||||
- Transformative content (translated, rewritten)
|
||||
- Fair use for news aggregation
|
||||
|
||||
### Privacy
|
||||
- No user tracking beyond analytics
|
||||
- GDPR compliant
|
||||
- Cookie consent
|
||||
|
||||
### API Rate Limits
|
||||
- Medium: Respectful scraping (no overload)
|
||||
- Claude: Within API limits
|
||||
- Caching to reduce costs
|
||||
|
||||
---
|
||||
|
||||
## 📈 SEO Strategy
|
||||
|
||||
### On-Page
|
||||
- Burmese Unicode (proper encoding)
|
||||
- Meta tags (og:image, description)
|
||||
- Structured data (Article schema)
|
||||
- Fast loading (<2s)
|
||||
- Mobile-first design
|
||||
|
||||
### Content
|
||||
- 10 articles/day = 300/month
|
||||
- Consistent publishing schedule
|
||||
- Long-form content (800-1200 words)
|
||||
- Internal linking
|
||||
- Fresh content daily
|
||||
|
||||
### Technical
|
||||
- Sitemap generation
|
||||
- Robots.txt optimization
|
||||
- CDN (Vercel global edge)
|
||||
- SSL/HTTPS (automatic)
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Maintenance
|
||||
|
||||
### Daily (Automated)
|
||||
- Content pipeline runs
|
||||
- 10 articles published
|
||||
- Database cleanup
|
||||
|
||||
### Weekly (5 mins)
|
||||
- Check analytics
|
||||
- Review top articles
|
||||
- Adjust scraping sources if needed
|
||||
|
||||
### Monthly (30 mins)
|
||||
- Performance review
|
||||
- SEO optimization
|
||||
- Add new content sources
|
||||
- Update translations if needed
|
||||
|
||||
---
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Pipeline Not Running
|
||||
```bash
|
||||
# Check logs
|
||||
railway logs
|
||||
|
||||
# Manually trigger
|
||||
python backend/run_pipeline.py
|
||||
```
|
||||
|
||||
### Translation Errors
|
||||
```bash
|
||||
# Check API key
|
||||
echo $ANTHROPIC_API_KEY
|
||||
|
||||
# Test translation
|
||||
python backend/translator.py --test
|
||||
```
|
||||
|
||||
### Database Issues
|
||||
```bash
|
||||
# Reset database (careful!)
|
||||
python backend/init_db.py --reset
|
||||
|
||||
# Backup first
|
||||
pg_dump $DATABASE_URL > backup.sql
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
**Creator:** Zeya Phyo
|
||||
**AI Assistant:** Bob (OpenClaw)
|
||||
|
||||
**Issues:** GitHub Issues tab
|
||||
**Updates:** Follow development commits
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Roadmap
|
||||
|
||||
### Phase 1 (Week 1) ✅
|
||||
- [x] Website built
|
||||
- [x] Content pipeline working
|
||||
- [x] 10 articles/day automated
|
||||
- [x] Deployed & live
|
||||
|
||||
### Phase 2 (Week 2-4)
|
||||
- [ ] Analytics dashboard
|
||||
- [ ] Social media auto-sharing
|
||||
- [ ] Newsletter integration
|
||||
- [ ] Admin panel improvements
|
||||
|
||||
### Phase 3 (Month 2-3)
|
||||
- [ ] Mobile app (optional)
|
||||
- [ ] Telegram bot integration
|
||||
- [ ] Video content (YouTube shorts)
|
||||
- [ ] Podcast summaries
|
||||
|
||||
### Phase 4 (Month 4+)
|
||||
- [ ] User accounts & comments
|
||||
- [ ] Community features
|
||||
- [ ] Premium content tier
|
||||
- [ ] AI tool directory
|
||||
|
||||
---
|
||||
|
||||
## 📜 License
|
||||
|
||||
MIT License - Feel free to use, modify, distribute
|
||||
|
||||
---
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
|
||||
- Medium for AI content
|
||||
- Anthropic Claude for translation
|
||||
- Myanmar tech community
|
||||
- Open source contributors
|
||||
|
||||
---
|
||||
|
||||
**Built with ❤️ in Myanmar 🇲🇲**
|
||||
|
||||
**Let's make AI accessible to all Burmese speakers!** 🚀
|
||||
Reference in New Issue
Block a user