A newsletter project to receive the top stories from the Hacker News forum via email
- TypeScript 91.7%
- CSS 3.7%
- HTML 2.7%
- JavaScript 0.9%
- Dockerfile 0.7%
- Other 0.3%
| .gitea/workflows | ||
| .github/workflows | ||
| .husky | ||
| .vscode | ||
| app | ||
| components | ||
| contexts | ||
| hooks | ||
| prisma | ||
| public | ||
| utils | ||
| .env.example | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierrc | ||
| .yarnrc.yml | ||
| commitlint.config.ts | ||
| docker-compose.yml | ||
| Dockerfile | ||
| LICENSE | ||
| middleware.ts | ||
| next.config.js | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| README.md | ||
| tailwind.config.ts | ||
| tsconfig.json | ||
| vercel.json | ||
| yarn.lock | ||
📰 HackerNews Newsletter
A Next.js application that aggregates HackerNews stories and delivers them as personalized daily newsletters.
✨ Features
- 📧 Daily newsletter containing curated HackerNews stories
- ☁️ Vercel hosting integration
🚀 Future improvements
- ⏰ Cron every 10 minutes and reduce time delta to 10 minutes: people are more likely to open the newsletter if delivered around the time when they subscribed (if cron becomes not enough, then the cost of sending all the emails might be a bigger issue)
🛠️ Tech Stack
- ⚡ Next.js
- 🗄️ Prisma (Database ORM)
- 🚀 Vercel (Hosting)
- 📝 Custom email templates
🏁 Getting Started
📋 Prerequisites
- 📦 Node.js
- 🐳 Docker
- 🔧 Vercel CLI
- 🧶 Yarn package manager
💻 Installation
- Clone the repository:
git clone https://github.com/RiccardoSenica/newsletter-hackernews
cd hackernews-newsletter
- Install dependencies:
yarn install
- Set up Vercel:
# Install Vercel CLI
yarn add -g vercel@latest
# Link to your Vercel project
yarn vercel:link
# Pull environment variables
yarn vercel:env
- Set up the database:
# Push Prisma schema to database
yarn db:push
# Generate Prisma client
yarn prisma:generate
🔧 Development
Run locally with Docker:
docker-compose up --build
🗄️ Database Management
Reset database (⚠️ caution: this will delete all data):
yarn db:reset