public

Social Income

#Tech4Good   #OpenSource   #Solidarity

Social Income is a radically simple solution in the fight against poverty. The open-source initiative converts donations into an unconditional basic income, sent directly to the mobile phones of people living in poverty in the Global South.

https://user-images.githubusercontent.com/6095849/191377786-10cdb4a1-5b25-4512-ade9-2cc0e153d947.mp4

What Is In This Repository?

This repository contains the public website, internal tools, the shared design system, local development seed data, and the recipient mobile app.

/
├─ design-system/         Shared React components and Storybook
├─ recipients_app/        Mobile app for Social Income recipients
├─ seed/                  Firebase emulator seed data
└─ website/               Next.js app, APIs, database, and tests

website/ and design-system/ are npm workspaces. They share one lockfile at the repository root.

website/

The main Next.js application. It contains:

• Public website: the public Social Income website. Parts are still hardcoded, while more content is being moved to Storyblok CMS.
• Portal: internal operations tool for program management, payments, recipients, contributors, and admin functionality.
• Dashboard: contributor self-service area for payments, subscriptions, and personal details.
• Partner Space: local partner self-service area for recipients, candidates, and partner profile data.
• API routes: backend endpoints used by the website and the recipient mobile app.
• Database layer: Prisma ORM with PostgreSQL.
• Backend: a modular monolith under website/src/modules. Pages and route handlers call module services and actions. Services call repositories (Prisma) and integrations (external APIs). The module contract is in website/AGENTS.md.
• Hosting: Vercel. Settings and cron jobs are in website/vercel.json. The PostgreSQL database runs on Neon. Firebase stays for auth and storage.
• Tests: unit tests and Playwright end-to-end tests.

design-system/

Shared UI components (@socialincome/design-system): buttons, dialogs, forms, badges, and other primitives built with Radix and Tailwind. It also holds the global styles and fonts. The website imports the package, but the package never imports the website, so other Next.js apps can reuse it.

The components are documented in Storybook. Storybook is deployed as its own Vercel project with design-system as the root directory. See design-system/AGENTS.md for the conventions.

recipients_app/

Mobile app for recipients. Recipients can log in, view payment history, and complete surveys. See recipients_app/README.md for mobile setup details.

seed/

Seed data for the local Firebase emulators. Firebase Auth users are imported automatically when the local development environment starts.

Architecture And Conventions

The conventions for each workspace live in AGENTS.md files, written for people and coding agents alike:

• AGENTS.md: repository overview and the checks to run
• website/AGENTS.md: backend modules, integrations and lib, and how the website uses the design system
• design-system/AGENTS.md: what belongs in the design system, component conventions, and design tokens

Most of these rules are enforced by ESLint, so npm run lint tells you when code does not fit.

Local Development Setup

Requirements

Install these tools before starting:

• mise
• Docker
• Node.js and npm through mise

On macOS, install mise with:

brew install mise

1. Install Tool Versions And Dependencies

cd website
mise install
npm ci --prefix ..

Dependencies are installed once from the repository root for both website/ and design-system/.

2. Prepare Environment Variables

Copy the local env template:

cd website
cp .env.local.sample .env.local

For most external contributors, the only required CMS value is:

STORYBLOK_PREVIEW_TOKEN="<public-content-delivery-api-token>"

Despite the name, STORYBLOK_PREVIEW_TOKEN is used by the website to load Storyblok content through the Content Delivery API. A public token is enough for frontend and UI work against published content.

If you need this token, ask a maintainer or contact [email protected]. Do not commit real API keys or secrets.

Maintainers may also need these Storyblok values for preview mode, webhooks, campaign submissions, or schema/type generation:

• STORYBLOK_PREVIEW_SECRET
• STORYBLOK_WEBHOOK_SECRET
• STORYBLOK_MANAGEMENT_TOKEN
• STORYBLOK_PERSONAL_ACCESS_TOKEN
• STORYBLOK_SPACE_ID

3. Start The Local Environment

cd website
mise dev

This starts:

• PostgreSQL in Docker
• Firebase emulators for Auth, Firestore, and Storage
• Next.js at http://localhost:3000

To work on shared components, start Storybook at http://localhost:6006:

cd design-system
npm run storybook

The Firebase emulator UI is available at:

http://localhost:4000

Auth users can be inspected at:

http://localhost:4000/auth

4. Seed The Local Database

Firebase Auth users are imported automatically from seed/auth_export when the emulator starts. The PostgreSQL database needs to be seeded once manually:

cd website
npm run db:seed

This fills the local database with representative test data from website/src/lib/database/seed.

To also create database entries for Storyblok campaigns (so campaign pages join CMS content with local donation data), run:

cd website
npm run db:seed:cms-campaigns:apply

This is create-only: it adds missing campaigns matched by Storyblok portalSlug and skips rows that already exist. Use npm run db:seed:cms-campaigns:apply:all to include unlisted campaigns, or npm run db:seed:cms-campaigns for a dry-run.

Requires STORYBLOK_PREVIEW_TOKEN in .env.local (see .env.local.sample).

5. Forward Stripe Webhooks

Stripe cannot call localhost directly. To test payment webhooks locally, install the Stripe CLI and forward events to the website:

brew install stripe/stripe-cli/stripe
stripe login
stripe listen --forward-to localhost:3000/api/v1/stripe/webhook \
  --events charge.succeeded,charge.updated,charge.failed,customer.updated,customer.subscription.created,customer.subscription.updated,customer.subscription.deleted

Copy the webhook signing secret printed by the CLI into website/.env.local:

STRIPE_WEBHOOK_SECRET=whsec_...

Restart mise dev, then make a test contribution. The CLI forwards those events to the local server.

The production Stripe webhook endpoint needs the same events: charge.succeeded, charge.updated, charge.failed, customer.updated, customer.subscription.created, customer.subscription.updated, and customer.subscription.deleted.

Local Login

Open the website at:

http://localhost:3000

Click Login in the top navigation and enter one of these local test users:

Area	Purpose	Email
Portal	Internal operations and admin tool	[email protected]
Dashboard	Contributor self-service area	[email protected]
Partner Space	Local partner self-service area	[email protected]

In staging and production, login sends a magic link by email. Locally, the Firebase emulator logs the magic link instead. Copy it from the terminal running mise dev, or open:

http://localhost:4000/logs

Development Flow

The main integration branch for active development is main.

1. Create your feature branch from main.
2. Keep your changes focused on one issue or feature.
3. Run the relevant checks locally.
4. Open a pull request back into main.
5. Wait for CI and review.

Example:

git checkout main
git pull
git checkout -b fix/issue-2064-short-description

Website and design system checks run for pull requests and for pushes to main. Vercel deploys through its Git integration: main goes to the staging environment, the production branch to production, and pull requests get preview deployments. To release, publish a GitHub release with a new tag on main. The Release workflow then pushes that commit to production, which deploys the website and the Firebase rules. Vercel runs npm run build, which applies the Prisma migrations before next build, so a failed migration fails the deployment and the previous one stays live. The previous deployment keeps serving against the migrated schema until the new one is live, so migrations must stay backwards compatible. Previews migrate their own Neon database branch. The cron jobs in website/vercel.json only run on production. To run one on staging, call it with Authorization: Bearer $CRON_SECRET. Production releases are handled by maintainers.

Useful local checks for website changes:

cd website
npm run lint
npm run typecheck
npm run test:unit
npm run test:e2e

Useful local checks for design system changes:

cd design-system
npm run lint
npm run typecheck
npm run test:unit

In CI, the E2E job reads Stripe test keys and tokens from the E2E_* repository secrets (see .github/workflows/website.yml).

For many small UI or content changes, lint and typecheck are a good minimum before opening a PR. Run the broader test suite when touching shared logic, authentication, database behavior, or user flows.

Storyblok Development

We use Storyblok as CMS for parts of the public website.

For normal local development, set the public Content Delivery API token in website/.env.local:

STORYBLOK_PREVIEW_TOKEN="<public-content-delivery-api-token>"

Use local HTTPS if you are working with Storyblok live preview:

cd website
mise run dev-ssl

Storyblok Type Generation

If you changed the Storyblok schema, regenerate the generated TypeScript types. This requires maintainer-level Storyblok credentials:

cd website
npm run storyblok:generate

The command logs into Storyblok, pulls component schemas, and writes generated types to website/src/generated/storyblok/types.

Storyblok Management Token

Campaign submissions and other Management API calls require a Personal Access Token (PAT) with write access. This is separate from STORYBLOK_PERSONAL_ACCESS_TOKEN, which the Storyblok CLI uses for schema pull and type generation.

To create or rotate the token:

1. Log in to Storyblok with [email protected].
2. Open Account Settings → Personal Access Tokens (PAT).
3. Create a token named Campaign management token with these scopes:
   • Assets: read, write
   • Stories: read, write, publish
   • Asset folders: read
   • Spaces: read
4. Set the token lifetime to 1 year.
5. Copy the token immediately. Storyblok only shows it once.

Store the token in these places:

• Local development: website/.env.local

  STORYBLOK_MANAGEMENT_TOKEN="<token>"
  

• 1Password: Social Income maintainer vault (for team access and rotation).

• Vercel (staging and production): project environment variable STORYBLOK_MANAGEMENT_TOKEN.

Set a calendar reminder to rotate the token before it expires.

Anonymous Campaign Submissions

Visitors can submit campaigns from the public /campaigns page. Submissions:

• create an inactive, non-public database Campaign with a server-generated slug
• upload a primary image and create an unpublished Storyblok Campaign story
• link database and CMS entries through Campaign.slug ↔ Storyblok.content.portalSlug

Publication happens manually in Storyblok. Published Storyblok stories are the sole public visibility gate for campaign pages (detail load and overview join).

Public active vs inactive is derived from campaign end date and goal progress (not the database isActive flag): a campaign is inactive when its finish date has passed or its goal amount has been reached. The overview filter and card linkability use that derived state; deep links to published stories still work after a campaign becomes inactive.

Server-only configuration lives in website/src/lib/campaign-submission.ts. Local development and deployed environments need STORYBLOK_MANAGEMENT_TOKEN; see Storyblok Management Token for creation and storage.

The token must be able to list assets in the default-images folder, create draft stories under pages/campaigns, and upload assets in the configured asset folder. If a submission fails after partial progress, the API attempts compensating cleanup of the created Storyblok asset, Storyblok story, and database row.

Future hardening (not part of the first version): Cloudflare Turnstile and distributed rate limiting on POST /api/campaign-submissions.

Mobile API

The recipients_app communicates with the Next.js API routes. The public API documentation is available at:

https://socialincome.org/v1/api-docs

Monitoring

The website pages Slack (#social-income-monitoring) for production failures that must not stay silent:

• sendSlackAlert from website/src/lib/utils/slack-alert.ts (Stripe webhooks, payment imports, scheduler jobs). It logs the message with a SLACK_ALERT prefix and, when SLACK_ALERT_WEBHOOK_URL is set, posts it to Slack after the response, at most once every 5 minutes per function instance. Only the message goes to Slack; details stay in the logs. Staging leaves the webhook unset and does not page Slack, because its Stripe and campaign data is incomplete.
• Cron runs and function errors are visible in the Vercel dashboard (Logs and Observability).

The recipients app still reports errors to Sentry.

Troubleshooting

Translations Or Generated Content Look Stale

rm -rf website/.next
cd website
mise dev

Firebase Seed Data Did Not Update

The Firebase emulators load seed data from seed/. If you changed the seed data and want a fresh start:

docker compose -f website/docker-compose.yml down --remove-orphans --volumes
cd website
mise dev

Docker Or Database State Looks Broken

If Prisma migrations fail, old containers are hanging around, or the local DB is in a strange state, reset the website Docker environment:

docker compose -f website/docker-compose.yml down --remove-orphans --volumes

This removes the website Docker containers and named volumes, including local PostgreSQL data. Run mise dev and npm run db:seed again afterwards.

E2E Screenshots Changed

The Playwright CI job updates changed screenshots and commits them back into the PR as the socialincome-ci GitHub App, which runs the checks again. Pull the branch before you push again. For Renovate, Dependabot and fork PRs the job only compares screenshots and fails if they changed.

Useful Commands

Database

cd website
npm run db:seed
npm run db:seed:cms-campaigns:apply
npm run db:studio
npm run db:migrate:dev

Dump Local Database

pg_dump -Fc --no-owner "postgresql://social-income:social-income@localhost:5432/social-income" > local.dump

Restore A Dump

pg_restore --clean --if-exists --no-owner -d "<database-url>" local.dump

Financial Contributions

Donate 1 Percent Of Your Income

Become a contributor of Social Income. Donations are tax-deductible in Switzerland.

Sponsor Dev Community

Become a sponsor and help build open-source software for more equality and less poverty. Donations through the GitHub Sponsor program support the developer community.

Social Income NGO

Non-Profit Organization

Social Income is a non-profit association (CHE-289.611.695) based in Zurich, Switzerland. Connect with us on X, Instagram, LinkedIn, Facebook, or by email.

Radical Transparency

We believe that transparency builds trust and trust builds solidarity. This is why we disclose our finances to the public.

Open Source Community

Open source is made by people like you. These individuals, among many others, have contributed to Social Income:

Software And IP Contributions

We receive in-kind donations from Anthropic, Google Nonprofit, GitHub, Codemagic, Cloudflare, Linktree, Twilio, Algolia, JetBrains, Storyblok, 1Password, Mux, Sentry, Make, Lineto. Our tools also use open-source technologies such as Storybook and Tailwind CSS.

License

This project is licensed under MIT, with the exception of the Unica77 font, which is exclusively licensed to Social Income.