Social Income is a radically simple solution in the fight against poverty. We turn 1% of anyone's salary into an unconditional basic income for people living in poverty – sent directly to their mobile phones. The tools that make this possible are built and continuously improved upon by an open source community, who use technical skills to take on the SDG 1 (No Poverty) and the SDG 10 (Reduced Inequality).
Social.Income.explained.mp4
Everybody cheers for equality
but forgets that without economic justice,
there can be no true equality.
- Admin Tool for managing contributors and recipients
(
↗admin.socialincome.org) - Mobile App for recipients (
↗Google Play Store link added soon) - Website for contributors (
↗socialincome.org)
Don't forget: open source isn’t an exclusive club. It’s made by people just like you. You don’t need to overthink what exactly your first contribution will be, or how it will look. Just follow the principle:
- Do something
- Determine how to do it better
- Rally others to help
Quick Links: ↗
Good first issues
↗
All issues
↗
Hacktoberfest 2022
We are using Firestore as database and FireCMS as UI tool. Staff can access the admin tool via admin.socialincome.org. For development we use Docker and rely on local emulators, which are populated with dummy seed data. This makes sure that no one will require production Firebase credentials to contribute.
🕐 It takes a few minutes to download packages the first time
- Build helper image locally:
docker compose build - Start development server including Firebase emulators:
docker compose up admin
This will expose the Admin Interface on
localhost:3000 and the Firebase Emulators on
localhost:4000.
An initial set of data is imported into the Firebase emulators during
startup. You can add, delete or amend data directly in the
admin tool or
localhost:4000. If you want to commit or keep
a local copy of your altered data set, you can execute in a second shell
(while emulator is still running) the command
docker exec -it public-admin-1 npm run emulators:export↓ see Shared > Shared Functions
Run the following command to start the emulators and run the tests
docker compose run admin npm run emulators:testWe are using Prettier to format the code
docker compose run admin npm run format-codeDeployment is handled automatically through GitHub actions. The production Firebase keys are ingested through GitHub secrets.
When creating a PR, an action tests the code and deploys it with the production credentials to a preview hosting. There, one can see the proposed change with the production Firestore database as backend.
After merging the PR into main, a deployment action automatically deploys the code to admin.socialincome.org.
Similar to Admin Tool the development doesn't require any production
Firebase credentials. We rely on local emulators which are populated
with dummy seed data. Follow Admin Tool setup to start emulators.
Open recipients_app project folder in your development environment of
choice. Building flavor should work seamlessly for Android Studio and VS
Code with predefined build configs.
We have two build flavors:
dev-> Connecting with Firebase Emulators (Firestore and Auth)prod-> Connecting with production online firebase project and need real Firebase configuration json / plist file
For development use dev flavor.
As Firebase emulators work on your local host machine the easiest way to run app is on the Android emulator. Real devices need some additional setup.
We build on reusable components for React and a test environment with Storybook.
We recommend to use make with the Makefile in the root of the
project. Those commands run the project inside Docker.
# Build the UI. For one time builds e.g. production builds.
$ make build-ui
# Run the development server on http://localhost:6006. Just use this while developing for the UI.
$ make serve-uiMore instructions in the README.md in ui subfolder.
(Code and instructions to be added)
Shared explanations, assets, code or functions for all three projects.
We are using firebase functions to run backend jobs. Those can e.g. be periodically triggered by pubsub cron definitions, by datastore triggers or through web callbacks. We are using Prettier to format the code.
These functions are mainly implemented using test-driven development.
- Build helper image locally:
docker compose build - Install dependencies:
docker compose run backend npm install. - Run the tests including Firebase emulators:
docker compose run backend npm run emulators:test. The first time this can take multiple minutes till the packages are downloaded. - With
docker compose run backend npm run serveone can also serve the webhooks on localhost.
Please use one of the templates on our issue page.
Become a contributor of Social Income (tax-deductible in Switzerland).
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 and organizing Social Coding Nights.
Social Income is a non-profit association (CHE-289.611.695) based in Zurich, Switzerland.
We believe that transparency builds trust and trust builds solidarity. This is why we disclose our finances in realtime and publish our annual statements and overall carbon footprint.
Code: MIT
Font: The font is licensed exclusively for the use on the website socialincome.org and on the mobile apps of Social Income.