Gitpay is an open-source platform that integrates payment workflows using Git. It supports multiple workflows — including bounties (where funders attach rewards to issues and contributors earn them by submitting accepted pull requests) and payment requests (where contributors, maintainers, and service providers can request payment for work completed inside or outside of issues).

We have a Slack channel where you can collaborate with other people who are using Gitpay and work together to find solutions. Feel free to join the community and hang out on Slack with us.

Join us on Slack

Gitpay started as a bounty platform — a way for open-source maintainers to attach monetary rewards to GitHub issues and attract contributors to solve them. Over time the platform evolved to support payment requests, giving contributors, maintainers, and service providers a way to request payment for work that may not fit the classic bounty model. Today bounties are one of several payment workflows available on Gitpay.

Gitpay is an open-source platform that empowers collaboration and fairly rewards every kind of contribution to open-source projects. Whether you are solving issues for bounties, requesting payment for work you delivered, funding the features you need, or providing services to projects, Gitpay gives you the tools to collaborate and get paid — from anywhere in the world.

Gitpay is built around four distinct roles. Each role has its own journey on the platform:

This project has been made possible thanks to all the amazing people contributing their time and effort into making Gitpay better. You can also start contributing to the project and join the community by contributing to Gitpay on GitHub or join our team on GitHub first.

Join the Gitpay team on GitHub

To contribute to Gitpay, you will need the following:

• Node.js (currently at v17.3.0)
• React with webpack

To run the tests, use the following commands:

npm run migrate-test (first time)

npm run test (to run the tests)

To ensure full integration with the API services used by the platform, you will need the API keys. You should make a copy of your .env.example file and rename it to .env with the right credentials. Please let me know if you need any of these credentials to solve an issue (mail tarefas@gitpay.me).

You can do this with: cp .env.example .env

• Make sure to use Node v17 (you can use Node Version Manager (NVM) to manage and switch different Node versions)
• Don't forget to run npm install on the root and front-end folders

1. Install by running the following command: brew install postgres
2. Start the command service by running the following command: brew services start postgresql
3. Create a postgres user by running the following command: createuser postgres -s
4. Login into the Postgres cli by running the following command: psql -U postgres
5. Create a test database by typing the following command: create database gitpay_test;
6. Create a dev database by running the following command: create database gitpay_dev;
7. Run this command to exit: \q

1. Install by running the following command: sudo apt install postgresql
2. Start the command service by running the following command: sudo service postgresql start
3. Create a postgres user by running the following command: createuser postgres -s
4. Login into the Postgres cli by running the following command: sudo -i -u postgres
5. Access the Postgres prompt by running the following command: psql
6. Make sure the Postgres user has the correct password by typing the following command: ALTER USER postgres WITH PASSWORD 'postgres';
7. Create a test database by running the following command: CREATE DATABASE gitpay_test;
8. Create a dev database by running the following command: CREATE DATABASE gitpay_dev;
9. To finally exit, type the following command: \q

1. Download: access https://www.enterprisedb.com/downloads/postgres-postgresql-downloads and download the exe file for windows;
2. Install: proceed the installation with the postgreSQL setup wizard; once it is requested to provide a password for the database superuser, type postgres.
3. Login into postgres: psql -U postgres
4. Make sure postgres user has the correct password: ALTER USER postgres WITH PASSWORD 'postgres';
5. Create test database: CREATE DATABASE gitpay_test;
6. Create a dev database: CREATE DATABASE gitpay_dev;
7. Exit: \q

To run the migrations

npm run migrate

To create a new migration

sequelize migration:create --name modelname

How to create new models

• For Many to Many
  1. Create migration for first model (table organizations)
  2. Create migration for second model (table projects)
  3. Create migration for joint model (table organizations_projects)
  4. Change in the model to Project.belongsTo(models.Organization)
  5. Change in the second model to Organization.hasMany(models.Project)

For more information related to database seeding please refer: https://en.wikipedia.org/wiki/Database_seeding

To seed the database

npm run seed

For test environment

npm run seed-test

For exhaustive list of options available, refer migration.js in root directory

• install cross-env
• run npm run seed:windows and npm run seed-test:windows

• first go to frontend folder: cd frontend
• Then run the server: npm run dev

npm run start:dev

Then you can access at http://localhost:8082

When you run your backend node server, the e-mail notifications will output in your console, so when setting up a new user, you should look for the activation link:

 ----- email / subject ----
alexandre+contributor7@gitpay.me
Activate your account
 ----- end email ----
 ----- email content ----
[
  {
    type: 'text/html',
    value: '<p>Hi Contrib7,</p><p>Click <a href="[ACTIVATION LINK]">here</a> to activate your account.</p>\n' +
      '          \n' +
      '\n' +
      '<p>\n' +
      'Thanks, <br />\n' +
      'Gitpay Team\n' +
      '</p>\n'
  }
]
 ----- end email content ----

You will find the activation link on the e-mail example, copy and paste in your browser to activate your user locally.

Please don't change the translation files directly, they will be managed on Crowdin. The only thing you need to do is run

npm run translate

on front-end and use the React Intl (https://formatjs.io/docs/react-intl/) library to give id and default text to your strings.

• Docker Engine
• Docker Compose

• Docker Engine: https://docs.docker.com/install/linux/docker-ce/ubuntu/
• Docker Compose: https://docs.docker.com/compose/install/

• Docker and Docker Compose: sudo pacman -S docker docker-compose

• Run docker-compose up Then you can access at http://localhost:8082

• Run docker-compose -f docker-compose.test.yml up

Here you can start to learn how to create your first pull request and start to be a contributor: #247

• saip007
• Unnatii
• Prerna Verma
• I Gede Wicaksana
• Luísa Barros
• Caio Reis
• Shivam Latawa
• Md. Al Amin
• Siso
• Amrut
• Usman Sakirat Kehinde
• Qiwei
• Adam Ash
• Shawn Noruzi
• Ssentongo Alex
• Tushar Kudal
• Onamade Okikioluwa
• Basukinath Tiwari
• Paulo Henrique

Become a financial contributor and help us sustain our community. [Contribute]

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

This project is licensed under the Attribution-NonCommercial-NoDerivatives 4.0 International license. Please review the license terms and conditions for details.

💙 If Gitpay helps you or your project, consider sponsoring to support sustainable open-source funding:

• GitHub Sponsors: https://github.com/sponsors/alexanmtz
• Open Collective: https://opencollective.com/gitpay