A Next.js application that helps teams generate email-friendly reports for GitHub backlog statistics and sprint details. Built with ❤️ and fully vibe coded.
- GitHub Authentication: Secure login using GitHub OAuth
- Backlog Statistics: Generate 30-day reports including:
- New PBIs created
- PBIs with YakShaver label
- Completed PBIs
- Sprint Details: View and export sprint information including:
- Issue details
- Assignees
- Status
- Estimates
- Export Options:
- Copy as Markdown for documentation
- Copy as HTML for email-friendly tables
- Modern UI: Built with Ant Design for a polished user experience
- Frontend: Next.js, React, TypeScript
- UI: Ant Design
- Authentication: NextAuth.js
- API: GitHub GraphQL API
- Styling: CSS-in-JS
- Node.js (v18 or later)
- pnpm (recommended) or npm/yarn
- GitHub OAuth App credentials
- Clone the repository:
git clone https://github.com/your-username/email-gen.git
cd email-gen- Install dependencies:
pnpm install
# or
npm install
# or
yarn install- Create a
.envfile in the root directory with the following variables:
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=<generate-a-random-string>
GITHUB_ID=<your-github-client-id>
GITHUB_SECRET=<your-github-client-secret>- Run the development server:
pnpm dev
# or
npm run dev
# or
yarn dev- Open http://localhost:3000 in your browser.
| Variable | Description |
|---|---|
NEXTAUTH_URL |
The base URL of your application |
NEXTAUTH_SECRET |
A random string used to encrypt the JWT |
GITHUB_ID |
Your GitHub OAuth app client ID |
GITHUB_SECRET |
Your GitHub OAuth app client secret |
- Go to GitHub Settings > Developer Settings > OAuth Apps
- Create a new OAuth App
- Set the following:
- Application name: Your app name
- Homepage URL: Your app URL
- Authorization callback URL:
{NEXTAUTH_URL}/api/auth/callback/github
- Copy the Client ID and generate a new Client Secret
This project was vibe coded with love. Feel free to contribute by:
- Forking the repository
- Creating a feature branch
- Making your changes
- Submitting a pull request
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with Next.js
- Styled with Ant Design
- Powered by GitHub's API
- Made possible by the amazing open-source community
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.