Implement grantee report submission system

.env.example

@@ -1,16 +1,60 @@
+# Giscus configuration
+NEXT_PUBLIC_GISCUS_REPO=
+NEXT_PUBLIC_GISCUS_REPOSITORY_ID=
+NEXT_PUBLIC_GISCUS_CATEGORY=
+NEXT_PUBLIC_GISCUS_CATEGORY_ID=
+NEXT_PUBLIC_UTTERANCES_REPO=
+NEXT_PUBLIC_DISQUS_SHORTNAME=
+
+# Mailchimp configuration
+MAILCHIMP_API_KEY=
+MAILCHIMP_API_SERVER=
+MAILCHIMP_AUDIENCE_ID=
+
+# Buttondown configuration
+BUTTONDOWN_API_KEY=
+
+# ConvertKit configuration
+CONVERTKIT_API_KEY=
+# curl https://api.convertkit.com/v3/forms?api_key=<your_public_api_key> to get your form ID
+CONVERTKIT_FORM_ID=
+
+# Klaviyo configuration
+KLAVIYO_API_KEY=
+KLAVIYO_LIST_ID=
+
+# Revue configuration
+REVUE_API_KEY=
+
+# EmailOctopus configuration
+EMAILOCTOPUS_API_KEY=
+EMAILOCTOPUS_LIST_ID=
+
+# GitHub configuration
 GH_ACCESS_TOKEN=
 GH_ORG=OpenSats
 GH_APP_REPO=applications
 GH_REPORTS_REPO=reports
+
+# SendGrid configuration
 SENDGRID_API_KEY=
 SENDGRID_RECIPIENT=
 SENDGRID_RECEPIENT=
 SENDGRID_CC=
 SENDGRID_VERIFIED_SENDER=
+
+# BTC Pay configuration
 BTCPAY_STORE_ID=
 BTCPAY_URL=
 BTCPAY_API_KEY=
+
+# Stripe configuration
 STRIPE_SECRET_KEY=
 ZAPRITE_USER_UUID=
+
+# Google configuration
 NEXT_PUBLIC_GOOGLE_DOC_ID=
-NEXT_PUBLIC_GOOGLE_API_KEY=
+NEXT_PUBLIC_GOOGLE_API_KEY=
+
+# Session configuration
+SESSION_SECRET=complex_password_at_least_32_characters_long

.env.local.example

@@ -0,0 +1,12 @@
+# GitHub Configuration
+GH_ACCESS_TOKEN=your_github_access_token
+GH_BOT_TOKEN=your_github_bot_token
+GH_ORG=OpenSats
+GH_REPORTS_REPO=reports
+
+# Email Configuration
+SENDGRID_API_KEY=your_sendgrid_api_key
+EMAIL_FROM=support@opensats.org
+
+# Session Configuration
+SECRET_COOKIE_PASSWORD=complex_password_at_least_32_characters_long

.eslintignore

@@ -1 +1,2 @@
 node_modules
+scripts/

.gitignore

@@ -33,9 +33,11 @@ npm-debug.log*
 
 # local env files
 .env.local
+.env.local.rtf
 .env.development.local
 .env.test.local
 .env.production.local
+cookies.txt
 
 # Contentlayer
 .contentlayer

PULL_REQUEST.md

@@ -0,0 +1,69 @@
+# Grantee Report Submission System
+
+## Overview
+
+This pull request implements a complete report submission system for OpenSats grantees. The system allows grantees to validate their grant numbers, submit progress reports, and receive confirmation emails with a copy of their submitted reports.
+
+## Key Features
+
+### 1. Grantee Report Submission Flow
+
+- **Two-Step Process**: Grant validation followed by report submission
+- **Grant Validation**: Verifies grant IDs (6-7 digit numbers) against GitHub issues
+- **Report Form**: Collects project updates, plans for next quarter, and use of funds
+- **Report Preview**: Allows grantees to preview their report before submission
+
+### 2. Email Notifications
+
+- **Confirmation Emails**: Sends a confirmation email to grantees when they submit a report
+- **Report Copy**: Includes a full copy of the submitted report in the email
+- **SendGrid Integration**: Uses SendGrid API for reliable email delivery
+- **OpenSats Branding**: Emails match OpenSats branding with orange header
+
+### 3. GitHub Integration
+
+- **Issue Comments**: Submits reports as comments on the corresponding grant issue
+- **Markdown Formatting**: Formats reports in Markdown for readability
+- **Grant Verification**: Uses GitHub API to verify grant numbers
+
+### 4. Development and Testing Support
+
+- **Test Mode**: Automatically enables test mode in non-production environments
+- **Test Grant IDs**: Supports test grant IDs (123456, 234567) in development
+- **Email Testing**: Includes a test script for verifying email functionality
+
+## Files Changed
+
+- **API Routes**: Implemented report submission and grant validation endpoints
+- **UI Components**: Created report form and preview components
+- **Email Utilities**: Built email sending functionality with SendGrid integration
+- **Documentation**: Added comprehensive setup and testing guides
+
+## Testing
+
+The system has been thoroughly tested in development mode:
+
+1. **Grant Validation**: Verified that valid grant IDs are properly recognized
+2. **Report Submission**: Confirmed that reports are correctly formatted and submitted
+3. **Email Delivery**: Tested that confirmation emails are sent with report content
+4. **Error Handling**: Verified that the system handles errors gracefully
+
+## Environment Variables
+
+The following environment variables are required:
+
+| Variable | Description |
+|----------|-------------|
+| `SENDGRID_API_KEY` | SendGrid API key for email sending |
+| `EMAIL_FROM` | Sender email address (support@opensats.org) |
+| `GH_ACCESS_TOKEN` | GitHub access token for API interactions |
+| `GH_ORG` | GitHub organization (OpenSats) |
+| `GH_REPORTS_REPO` | GitHub repository for reports (reports) |
+
+## Next Steps
+
+After merging this PR, the following steps are recommended:
+
+1. **User Testing**: Conduct testing with actual grantees
+2. **Documentation**: Create user-facing documentation for grantees
+3. **Monitoring**: Set up monitoring for the report submission process

components/ClosedNotice.tsx

@@ -0,0 +1,45 @@
+import Link from './Link'
+
+const ClosedNotice = () => {
+  return (
+    <div
+      className="rounded-b border-t-4 border-orange-500 bg-yellow-100 px-4 py-3 text-yellow-900 shadow-md"
+      role="alert"
+    >
+      <div className="flex">
+        <div className="py-1">
+          <svg
+            className="mr-4 h-6 w-6 fill-current text-orange-500"
+            xmlns="http://www.w3.org/2000/svg"
+            viewBox="0 0 20 20"
+          >
+            <path d="M2.93 17.07A10 10 0 1 1 17.07 2.93 10 10 0 0 1 2.93 17.07zm12.73-1.41A8 8 0 1 0 4.34 4.34a8 8 0 0 0 11.32 11.32zM9 11V9h2v6H9v-4zm0-6h2v2H9V5z" />
+          </svg>
+        </div>
+        <div>
+          <p className="font-bold">Applications are currently closed!</p>
+          <p className="text-sm">
+            Grant applications are currently closed as per our{' '}
+            <Link href="/faq#when-is-the-best-time-to-apply">
+              quarterly schedule
+            </Link>
+            . Please have a look at{' '}
+            <Link href="/blog/2024-year-in-review">last year's report</Link> to
+            see what kind of projects we support.
+          </p>
+          <p className="text-sm">
+            If you want to prepare a submission, please get familiar with our{' '}
+            <Link href="/apply#critera">application criteria</Link> as well as
+            our <Link href="/selection">grant selection process</Link>.
+          </p>
+          <p className="text-sm">
+            We will re-open applications as soon as we can. Two weeks&trade;.
+            Okay, maybe four.
+          </p>
+        </div>
+      </div>
+    </div>
+  )
+}
+
+export default ClosedNotice