{"id":39760445,"url":"https://github.com/azacdev/luminix-broadcast","last_synced_at":"2026-01-18T11:37:24.006Z","repository":{"id":319568246,"uuid":"1078382511","full_name":"azacdev/luminix-broadcast","owner":"azacdev","description":"Email broadcast platform for managing subscribers and sending campaigns. Built with Next.js, Drizzle, Resend, and Shadcn.","archived":false,"fork":false,"pushed_at":"2025-10-27T20:47:05.000Z","size":348,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-27T21:19:25.598Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/azacdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-17T16:36:01.000Z","updated_at":"2025-10-27T20:47:08.000Z","dependencies_parsed_at":"2025-10-19T14:46:49.598Z","dependency_job_id":null,"html_url":"https://github.com/azacdev/luminix-broadcast","commit_stats":null,"previous_names":["azacdev/luminix-newsletter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/azacdev/luminix-broadcast","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azacdev%2Fluminix-broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azacdev%2Fluminix-broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azacdev%2Fluminix-broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azacdev%2Fluminix-broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/azacdev","download_url":"https://codeload.github.com/azacdev/luminix-broadcast/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/azacdev%2Fluminix-broadcast/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28535169,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T10:13:46.436Z","status":"ssl_error","status_checked_at":"2026-01-18T10:13:11.045Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-01-18T11:37:23.313Z","updated_at":"2026-01-18T11:37:23.996Z","avatar_url":"https://github.com/azacdev.png","language":"TypeScript","readme":"# Luminix Broadcast\n\nA modern, full-featured email broadcast management system built with Next.js, tRPC, and Resend. Manage subscribers, create broadcasts, and send beautiful emails with ease.\n\n## Features\n\n- **📧 Email Broadcasting:** Create and send beautiful email broadcasts to your subscribers\n- **👥 Subscriber Management:** Add, import, and manage your subscriber list with ease\n- **🎨 Rich Text Editor:** Compose emails with a powerful WYSIWYG editor\n- **📱 Responsive Design:** Fully responsive interface that works on all devices\n- **🔒 Type-Safe:** End-to-end type safety with TypeScript and tRPC\n- **📤 Bulk Import:** Import subscribers via CSV or manual entry\n- **📧 Email Preview:** Preview your broadcasts before sending\n\n## Tech Stack\n\n- **[Next.js 14](https://nextjs.org/)** - React framework with App Router\n- **[TypeScript](https://www.typescriptlang.org/)** - Type-safe JavaScript\n- **[tRPC](https://trpc.io/)** - End-to-end typesafe APIs\n- **[Drizzle ORM](https://orm.drizzle.team/)** - TypeScript ORM for SQL databases\n- **[PostgreSQL](https://www.postgresql.org/)** - Relational database\n- **[Resend](https://resend.com/)** - Modern email API for developers\n- **[React Email](https://react.email/)** - Build and send emails using React components\n- **[Tailwind CSS](https://tailwindcss.com/)** - Utility-first CSS framework\n- **[shadcn/ui](https://ui.shadcn.com/)** - Re-usable component library\n- **[React Hook Form](https://react-hook-form.com/)** - Performant form validation\n\n## Prerequisites\n\nBefore you begin, ensure you have the following installed:\n\n- **Node.js** 18.x or higher\n- **pnpm** (recommended) or npm/yarn\n- **PostgreSQL** database\n- **Resend Account** (free tier available)\n\n## Getting Started\n\n### 1. Clone the Repository\n```bash\ngit clone https://github.com/azacdev/luminix-broadcast.git\ncd luminix-broadcast\n```\n\n### 2. Install Dependencies\n```bash\npnpm install\n# or\nnpm install\n# or\nyarn install\n```\n\n### 3. Set Up PostgreSQL Database\n\nThis project uses [Neon](https://neon.tech/) - a serverless PostgreSQL database.\n\n#### Option 1: Using Neon (Recommended)\n\n1. Go to [Neon.tech](https://neon.tech) and sign up for a free account\n2. Click **Create a project**\n3. Give your project a name (e.g., \"Luminix Broadcast\")\n4. Select a region closest to your users\n5. Click **Create project**\n6. Copy the connection string from the **Connection Details** section\n7. Add it to your `.env` file as `DATABASE_URL`\n\n### 4. Configure Environment Variables\n\nCreate a `.env` file in the root directory by copying the example:\n```bash\ncp .env.example .env\n```\n\nUpdate the `.env` file with your configuration:\n```env\n# Database\nDATABASE_URL=\"postgresql://user:password@localhost:5432/luminix_broadcast\"\n\n# App Configuration\nNEXT_PUBLIC_APP_URL=http://localhost:3000\n\n# Resend Email Service\nRESEND_API_KEY=re_123456789abcdefghijklmnop\nRESEND_AUDIENCE_ID=abc12345-6789-defg-hijk-lmnopqrstuv\nNEXT_PUBLIC_RESEND_DOMAIN_EMAIL=noreply@yourdomain.com\n```\n\n### 5. Set Up Resend\n\n#### Step 1: Create a Resend Account\n\n1. Go to [Resend.com](https://resend.com) and sign up for a free account\n2. Verify your email address\n\n#### Step 2: Add and Verify Your Domain\n\n1. Navigate to **Domains** in your Resend dashboard\n2. Click **Add Domain**\n3. Enter your domain name (e.g., `yourdomain.com`)\n4. Add the provided DNS records to your domain registrar:\n   - **MX Record** (for receiving bounces)\n   - **TXT Record** (for SPF verification)\n   - **CNAME Records** (for DKIM authentication)\n5. Wait for DNS propagation (usually 5-15 minutes, can take up to 48 hours)\n6. Click **Verify** in Resend dashboard\n\n**Note:** If you don't have a custom domain, you can use Resend's test domain for development, but emails will only be sent to your verified email address.\n\n#### Step 3: Get Your API Key\n\n1. Go to **API Keys** in your Resend dashboard\n2. Click **Create API Key**\n3. Give it a name (e.g., \"Luminix broadcast\")\n4. Select the appropriate permissions (Full Access for development)\n5. Copy the API key and add it to your `.env` file as `RESEND_API_KEY`\n\n**⚠️ Important:** Keep your API key secure and never commit it to version control.\n\n#### Step 4: Create an Audience (Optional but Recommended)\n\n1. Go to **Audiences** in your Resend dashboard\n2. Click on **API Reference** to view your existing audience ID\n3. Or click **Create Audience** to create a new one:\n   - Give it a name (e.g., \"broadcast Subscribers\")\n   - Configure your audience settings\n4. Copy the Audience ID and add it to your `.env` file as `RESEND_AUDIENCE_ID`\n\n**Note:** Using Audiences helps you manage bounces, complaints, and unsubscribes automatically.\n\n#### Step 5: Set Your Sender Email\n\nIn your `.env` file, set `NEXT_PUBLIC_RESEND_DOMAIN_EMAIL` to an email address using your verified domain:\n```env\nNEXT_PUBLIC_RESEND_DOMAIN_EMAIL=noreply@yourdomain.com\n```\n\n### 6. Run Database Migrations\n```bash\npnpm db:push\n# or\nnpm run db:push\n```\n\n### 7. Start the Development Server\n```bash\npnpm dev\n# or\nnpm run dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) in your browser to see the application.\n\n## Project Structure\n```\nluminix-broadcast/\n├── app/\n│   ├── (dashboard)/          # Dashboard routes with shared layout\n│   │   ├── broadcasts/       # Broadcast management pages\n│   │   ├── subscribers/      # Subscriber management pages\n│   │   └── layout.tsx        # Dashboard layout with sidebar\n│   ├── api/                  # API routes\n│   │   └── trpc/             # tRPC endpoint\n│   ├── globals.css           # Global styles\n│   ├── layout.tsx            # Root layout\n│   └── page.tsx              # Landing page\n├── components/\n│   ├── sidebar/              # Sidebar navigation components\n│   └── ui/                   # shadcn/ui components\n├── db/\n│   ├── drizzle.ts            # Database connection\n│   └── schema.ts             # Database schema\n├── emails/\n│   └── broadcast-email.tsx   # Email templates\n├── modules/\n│   ├── broadcast/            # Broadcast feature module\n│   │   ├── server/           # Server-side procedures\n│   │   └── ui/               # Client components\n│   └── subscribers/          # Subscribers feature module\n│       ├── server/           # Server-side procedures\n│       └── ui/               # Client components\n├── trpc/\n│   ├── routers/              # tRPC router definitions\n│   ├── client.tsx            # tRPC client setup\n│   └── init.ts               # tRPC initialization\n├── .env                      # Environment variables (not in git)\n├── .env.example              # Environment variables template\n└── package.json              # Project dependencies\n```\n\n## Available Scripts\n\n- `pnpm dev` - Start development server\n- `pnpm build` - Build for production\n- `pnpm start` - Start production server\n- `pnpm lint` - Run ESLint\n- `pnpm db:push` - Push database schema changes\n- `pnpm db:studio` - Open Drizzle Studio (database GUI)\n\n## Key Features Explained\n\n### Broadcasting System\n\n- Create and schedule email broadcasts\n- Rich text editor with formatting options\n- Preview emails before sending\n- Send to all subscribers or specific segments\n\n### Subscriber Management\n\n- Add subscribers manually\n- Bulk import via CSV\n- View subscriber details and activity\n- Remove subscribers\n\n### Email Templates\n\n- Professional, responsive email templates\n- Customizable branding\n\n## Deployment\n\n### Deploy to Vercel\n\nThe easiest way to deploy this application:\n\n1. Push your code to GitHub\n2. Import your repository in [Vercel](https://vercel.com)\n3. Add your environment variables in Vercel's project settings\n4. Deploy!\n\n### Environment Variables for Production\n\nMake sure to set these in your Vercel project settings:\n\n- `DATABASE_URL` - Your production PostgreSQL database URL\n- `NEXT_PUBLIC_APP_URL` - Your production domain (e.g., https://yourdomain.com)\n- `RESEND_API_KEY` - Your Resend API key\n- `RESEND_AUDIENCE_ID` - Your Resend Audience ID\n- `NEXT_PUBLIC_RESEND_DOMAIN_EMAIL` - Your verified sender email\n\n## Troubleshooting\n\n### Emails Not Sending\n\n- Verify your domain is properly configured in Resend\n- Check that your API key has the correct permissions\n- Ensure `NEXT_PUBLIC_RESEND_DOMAIN_EMAIL` uses your verified domain\n- Check Resend dashboard for any error logs\n\n### Database Connection Issues\n\n- Verify your `DATABASE_URL` is correct\n- Ensure PostgreSQL is running\n- Check that database migrations have been applied\n\n### Type Errors\n\n- Run `pnpm install` to ensure all dependencies are installed\n- Restart your TypeScript server in your IDE\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Support\n\nIf you have any questions or run into issues, please:\n\n1. Check the [Issues](https://github.com/azacdev/luminix-broadcast/issues) page\n2. Create a new issue if your problem isn't already listed\n3. Contact support at support@azacdev.com\n\n## Acknowledgments\n\n- [Next.js](https://nextjs.org/) for the amazing framework\n- [Resend](https://resend.com/) for the reliable email API\n- [shadcn/ui](https://ui.shadcn.com/) for the beautiful components\n- [tRPC](https://trpc.io/) for type-safe APIs\n\n---\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazacdev%2Fluminix-broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazacdev%2Fluminix-broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazacdev%2Fluminix-broadcast/lists"}