#Tech4Good   #OpenSource   #Solidarity

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

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

SDG 1    SDG 10

OSS Tools by Social Income

	Admin Tool	Website	Mobile App
Purpose	Make it simple to manage payments, contributors and recipients	Raising donations and inform the public	Make it simple for recipients to manage payments and surveys
Instructions	Readme	Readme	Readme / Contributing
Localhost	localhost:3000 / 4000	localhost:3001	–
Staging	staging-admin.socialincome.org	staging.socialincome.org	Testflight / App Distribution
Production	admin.socialincome.org	socialincome.org	iOS / Android
Issues	Open issues	Open issues	Open issues
UI Library	–	Storybook / Figma	–

Code Contributions

Basic Steps to Contribute

1. Choose an issue and leave a comment that you'd like to work on it
   (upon we assign it to you) ↗
   All issues
   ↗
   Help wanted
   ↗
   Good first issues

2. Setup the basic development environment ↓
   Setup

3. Clone the repo and work on it ↓ Developing

4. Create a PR and wait for it to be reviewed

5. If approved, the PR will be merged into the main branch, first on
   the staging and subsequently on production ↓
   Deployments

Frontend developers: You can also develop UI components with
Tailwind CSS and
shadcn/ui independent of the website
(Readme / Contributing). The
components are all collected in our
Storybook and
Figma file.

Basic Development Setup

We are mainly leveraging the following tools:

• Firestore for data
  management
• Firebase Authentication for
  user management
• Firebase Hosting to serve
  static content, such as the admin app
• Vercel for website hosting
• Firebase Functions to
  run backend code in a serverless framework
• Firebase Storage to store
  documents and other files
• Firebase Emulators
  for the local dev environment

Local development environment

We use mise-en-place to run the local
development environment. Please familiarize yourself with the
documentation to understand how to set up and use it.

If you have mise installed, you can run the following command to set up
the local development environment:

mise install

and then start the local development environment with:

mise dev

🐳 Docker Required: Install and run
Docker Desktop to
use the local database.

To run the tools separately either use the scripts in the package.json
file or run the mise tasks, e.g. both these commands start the admin
tool:

mise run admin

npm run admin:serve

Firestore ➜ PostgreSQL Migration

We’re moving from Firestore to PostgreSQL to improve relational
data modeling and consistency.
We’re using Prisma as our type-safe ORM.

🐳 Docker Required: Install and run
Docker Desktop to
use the local database.

Local Setup

Edit the schema at:
shared/src/database/schema.prisma

Run all commands from the root – they delegate to
@socialincome/shared.

🚀 Common DB Commands

npm run db:up               # Start local PostgreSQL via Docker
npm run db:down             # Stop and remove DB container
npm run db:generate         # Generate Prisma client
npm run db:studio           # Open Prisma Studio (GUI)

npm run db:migrate:dev      # Create & apply new migration (dev)
npm run db:migrate:create   # Only create migration (no apply)
npm run db:migrate:deploy   # Deploy migrations (staging/prod)
npm run db:migrate:reset    # Reset DB (dev only)
npm run db:migrate:status   # Check migration status
npm run db:introspect       # Pull schema from existing DB
npm run db:seed             # Run seed script

🧱 To create a migration, run npm run db:migrate:dev.
To just generate a file, use npm run db:migrate:create.

Developer Logins

No production credentials are needed for local development.

Localhost Admin Tool Login (Link)

Choose "Sign in with Google" and select the listed "Admin
([email protected])" account.

Staging Admin Tool Login (Link)

Contact the dev team
([email protected]) which can assign
you access rights to login.

Production Admin Tool Login (Link)

Only selected people from the SI team have access.

Localhost Website Login (Link)

1. Go to the Login page and select
2. Sign in with username [email protected] and password [email protected].

Staging Website Login (Link)

To create a donor account in the staging environment, proceed through
the
donation process.
Utilize the Stripe test card (4242
4242 4242 4242) for making a test donation.

Production Website Login (Link)

Only actual donors have accounts and can log in. Consider making a
(symbolic) donation to create your own account.

Data Seed

An initial dataset is imported into the Firebase emulators at startup.
You have the flexibility to add, delete, or modify data directly through
your Admin Tool or the
Firestore Admin Interface
locally. After making any changes, you can export the updated data to
the seed folder using the command npm run firebase:export.

Storyblok Development

1. Read the storyblok documentation.
2. Set the values STORYBLOK_PREVIEW_TOKEN and
   STORYBLOK_PREVIEW_SECRET to the
   env.development. You can find the
   STORYBLOK_PREVIEW_TOKEN at the
   storyblok_token
   and the STORYBLOK_PREVIEW_SECRET at the
   VISUAL_EDITOR
   in the preview-url.
3. (optional-step) npm run dev:ssl-proxy, this is needed if you want
   to preview the changes on the storyblok live editor for the local
   environment.

Format Code

We are using Prettier to format the code:
npm run format-code.

Deployments

Staging: PRs merged into main are automatically deployed to
staging (Admin Tool /
Website) upon core developer
approval. Check Github Actions for details.
Experienced contributors can deploy directly
without approval.

Production: Deployments are made by core developers via
GitHub releases.

Use the format "release-YYYY-MM-DD" for naming releases (example:
release-2021-02-27). For multiple releases on the same day, append a
suffix such as ".2", ".3", and so forth, to distinguish them (example:
release-2021-02-27.2).

Backups

We have a
function
which triggers hourly backups of our production firestore database. The
exports are saved to the
social-income-prod
bucket with a retention period of 30 days.

To restore the database you can
import
the most recent folder directly from the
social-income-prod
bucket.

Bugs & Feature Requests

You can report an issue or request a feature on our
issue page.
If you want to report a vulnareablity please refer to our
security policy.

Problem: Added or amended translations do not appear in the
localhost preview.

Solution: Remove the website/.next folder, which is automatically
generated, then re-execute npm run website:serve.

Financial Contributions

Donate 1 Percent of Your Income

Become a contributor of Social
Income (tax-deductible in Switzerland).

Sponsor Dev Community

Become a sponsor and
help ensure the development of open source software for more equality
and less poverty. Donations through the GitHub Sponsor program are used
for building a strong 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
X,
Insta,
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 isn’t an exclusive club. It’s made by people just like you.
These individuals, amongst many others, have made significant
contributions to Social Income's success:

Software and IP Contributions

We receive in-kind donations from
Google Nonprofit,
GitHub,
Codemagic, Linktree,
Twilio, Algolia,
JetBrains,
Storyblok,
1Password, Mux,
Sentry and Lineto. Our
tools also leverage other open-source technologies, including solutions
like FireCMS,
Storybook and
Tailwind CSS.

Licensing Information

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