Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 190 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,225 @@
# Milkroad Pro Archive
# 🥛 MilkRoad Pro - Public Archive

A professional, minimalist archive for Milkroad Pro cryptocurrency newsletters. Built with Next.js, featuring search functionality, responsive design, and a contact form.
> Making premium cryptocurrency research accessible to everyone

## Features
A community-driven archive of Milkroad Pro newsletters, built to preserve and share valuable crypto insights that were previously behind a paywall. This project aims to democratize access to quality cryptocurrency research and analysis.

- **Clean Design** - Monochromatic black/white/grey aesthetic
- **Full-Text Search** - Search newsletters by title and content
- **Responsive** - Works perfectly on desktop, tablet, and mobile
- **Contact Form** - EmailJS integration for inquiries
- **Fast** - Static site generation for optimal performance
- **SEO Optimized** - Sitemap, meta tags, and semantic HTML
- **Easy Content Management** - Just add Markdown files
## 📖 About This Project

## Quick Start
**MilkRoad Pro reports are now outdated**, and we believe valuable knowledge shouldn't be locked away. This archive makes these reports freely available to the public and welcomes community contributions to keep the content organized and accessible.

**We encourage anyone with access to additional reports to contribute and help grow this archive!**

## ✨ Features

- **📚 Full Archive Access** - Browse all available Milkroad Pro newsletters
- **🔍 Full-Text Search** - Quickly find newsletters by title and content
- **📱 Responsive Design** - Clean, minimalist interface that works on all devices
- **⚡ Fast Performance** - Static site generation for optimal loading speeds
- **🎨 Clean Aesthetics** - Professional black/white/grey design
- **✉️ Contact Form** - EmailJS integration for inquiries
- **🔎 SEO Optimized** - Sitemap, meta tags, and semantic HTML

## 🚀 Quick Start

### Prerequisites

- Node.js 18+ installed
- npm or pnpm package manager

### Installation

```bash
# Clone the repository
git clone https://github.com/8harath/MilkRoad-Pro.git
cd MilkRoad-Pro

\`\`\`bash
# Install dependencies
npm install

# Set up environment variables
# Set up environment variables (for contact form)
cp .env.example .env.local
# Edit .env.local with your EmailJS credentials
# Edit .env.local with your EmailJS credentials (optional)

# Run development server
npm run dev
\`\`\`
```

Visit [http://localhost:3000](http://localhost:3000) to see the archive locally.

## 🤝 How to Contribute

We welcome contributions from anyone who wants to help make these reports accessible! Here's how you can contribute:

### Adding Newsletters

1. **Fork this repository** - Click the "Fork" button at the top right of this page

2. **Clone your fork**
```bash
git clone https://github.com/YOUR-USERNAME/MilkRoad-Pro.git
cd MilkRoad-Pro
```

3. **Create a new branch**
```bash
git checkout -b add-newsletter-[newsletter-name]
```

4. **Add your newsletter**
- Place Markdown files in the `public/newsletters/` directory
- Use descriptive filenames (e.g., `bitcoin-market-analysis-jan-2024.md`)
- Follow this format:

```markdown
# Newsletter Title

**Date:** January 15, 2024

## Summary

Brief overview...

## Main Content

Your content here...
```

5. **Commit your changes**
```bash
git add .
git commit -m "Add: [Newsletter Title]"
```

6. **Push to your fork**
```bash
git push origin add-newsletter-[newsletter-name]
```

7. **Create a Pull Request**
- Go to your fork on GitHub
- Click "New Pull Request"
- Provide a clear description of what you're adding
- Submit the PR for review

### Other Ways to Contribute

- **Report Issues** - Found a bug or have a suggestion? [Open an issue](https://github.com/8harath/MilkRoad-Pro/issues)
- **Improve Documentation** - Help make setup and contribution guides clearer
- **Enhance Features** - Submit PRs for new features or improvements
- **Fix Bugs** - Help resolve existing issues
- **Improve Design** - Suggest or implement UI/UX improvements

### Contribution Guidelines

- Ensure newsletters are in Markdown format
- Use clear, descriptive filenames
- Include dates in newsletter content when available
- Keep formatting consistent with existing newsletters
- Test your changes locally before submitting a PR
- Write clear commit messages
- Be respectful and constructive in discussions

## 📁 Project Structure

```
MilkRoad-Pro/
├── app/ # Next.js app directory
│ ├── page.tsx # Homepage
│ ├── archive/ # Archive listing page
│ ├── newsletter/ # Individual newsletter pages
│ ├── intent/ # About/Intent page
│ ├── contact/ # Contact form page
│ └── layout.tsx # Root layout
├── components/ # Reusable React components
├── hooks/ # Custom React hooks
├── lib/ # Utility functions
├── public/
│ └── newsletters/ # 📄 Markdown newsletter files
├── styles/ # Global styles
├── SETUP.md # Detailed setup guide
├── SEO_OPTIMIZATIONS.md # SEO documentation
└── package.json # Dependencies
```

## 🛠️ Tech Stack

- **[Next.js 16](https://nextjs.org/)** - React framework with App Router
- **[React 19](https://react.dev/)** - UI library
- **[TypeScript](https://www.typescriptlang.org/)** - Type safety
- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first styling
- **[Radix UI](https://www.radix-ui.com/)** - Accessible UI components
- **[React Markdown](https://github.com/remarkjs/react-markdown)** - Markdown rendering
- **[EmailJS](https://www.emailjs.com/)** - Contact form integration
- **[Lucide Icons](https://lucide.dev/)** - Icon library
- **[Vercel Analytics](https://vercel.com/analytics)** - Performance monitoring

## 🔧 Configuration

### EmailJS Setup (Optional)

To enable the contact form:

Visit [http://localhost:3000](http://localhost:3000)
1. Sign up at [emailjs.com](https://www.emailjs.com)
2. Create an email service
3. Create a template with these variables: `{{from_name}}`, `{{user_email}}`, `{{message}}`
4. Add your credentials to `.env.local`:

## Adding Newsletters
```env
NEXT_PUBLIC_EMAILJS_SERVICE_ID=your_service_id
NEXT_PUBLIC_EMAILJS_TEMPLATE_ID=your_template_id
NEXT_PUBLIC_EMAILJS_PUBLIC_KEY=your_public_key
```

### Customization

1. Create a `.md` file in `public/newsletters/`
2. Example: `bitcoin-analysis.md`
3. The file will automatically appear in the archive
- **Colors & Styling**: Edit `app/globals.css` and Tailwind configuration
- **Site Metadata**: Update `app/layout.tsx`
- **Content**: Modify components in `components/` directory

\`\`\`markdown
# Newsletter Title
## 📦 Deployment

Your content here...
\`\`\`
### Deploy to Vercel (Recommended)

## Deployment
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/8harath/MilkRoad-Pro)

Deploy to Vercel with one click:
### Manual Deployment

\`\`\`bash
```bash
# Build the production version
npm run build

# Start production server
npm start
\`\`\`
```

See [SETUP.md](./SETUP.md) for detailed deployment instructions.
See [SETUP.md](./SETUP.md) for detailed deployment instructions and other hosting options.

## Configuration
## 📚 Additional Documentation

### EmailJS Setup
- [SETUP.md](./SETUP.md) - Detailed setup and deployment guide
- [SEO_OPTIMIZATIONS.md](./SEO_OPTIMIZATIONS.md) - SEO implementation details

1. Sign up at [emailjs.com](https://www.emailjs.com)
2. Create an email service
3. Create a template with variables: `{{from_name}}`, `{{user_email}}`, `{{message}}`
4. Add credentials to `.env.local`
## 🌐 Live Demo

### Customization
Visit the live site: [https://milk-road-pro.vercel.app](https://milk-road-pro.vercel.app)

Edit `app/globals.css` to change colors, fonts, and spacing.
## 📄 License

## Project Structure
This project is open source and available for anyone to use, modify, and distribute. Feel free to fork and adapt it for your own needs.

\`\`\`
app/ # Next.js app directory
├── page.tsx # Homepage
├── archive/ # Archive page
├── newsletter/ # Individual newsletter pages
├── intent/ # About page
├── contact/ # Contact form
└── layout.tsx # Root layout
## 🙏 Acknowledgments

components/ # Reusable components
lib/ # Utilities
public/
└── newsletters/ # Markdown files
\`\`\`
- Original content from Milkroad Pro
- Community contributors who help maintain this archive
- Open source libraries that make this project possible

## Technologies
## 💬 Contact & Support

- **Next.js 16** - React framework
- **Tailwind CSS** - Styling
- **React Markdown** - Markdown rendering
- **EmailJS** - Contact form
- **Lucide Icons** - Icons
- **Issues**: [GitHub Issues](https://github.com/8harath/MilkRoad-Pro/issues)
- **Discussions**: Use the contact form on the website
- **Maintainer**: [@8harath](https://github.com/8harath)

## License
---

Open source - feel free to use and modify.
**Remember**: Knowledge is most valuable when shared. Help us keep this archive comprehensive and accessible! 🚀
Loading