gitpay
 [](https://app.codacy.com/gh/worknenjoy/gitpay/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://opencollective.com/gitpay) [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fworknenjoy%2Fgitpay?ref=badge_shield) [](https://www.firsttimersonly.com/) [](http://isitmaintained.com/project/worknenjoy/gitpay 'Average time to resolve an issue') [](http://isitmaintained.com/project/worknenjoy/gitpay 'Percentage of issues still open') 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, or to have access to versioned files in a Git repository. ### Slack channel We have a Slack channel where you can collaborate with other Gitpay users to find solutions. Feel free to join the community and hang out with us on Slack. [Join us on Slack](https://join.slack.com/t/gitpay-workspace/shared_invite/zt-1ru4j0duc-mOPFRxkhRyMgavlGdlghmw) ## History 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. ## Why 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. ## Roles Gitpay is built around four distinct roles. Each role has its own journey on the platform: | Role | Description | |------|-------------| | **Contributor** | Find tasks, submit pull requests, and get rewarded for solving issues. Contributors can pick up bounties or submit payment requests for the work they deliver. | | **Maintainer** | Import issues from your repository, organize work, and pay contributors when tasks are completed. Maintainers control which bounties are accepted and coordinate the project workflow. | | **Funding** | Fund bounties for open-source issues and support the work you want to see shipped. Funders back issues they care about and the bounty is released automatically when the linked pull request is merged. | | **Service Provider** | Offer services (design, consulting, DevOps, etc.) to projects and request payment through the platform. Service providers are not necessarily tied to a GitHub issue. | ## Who is contributing? 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](CONTRIBUTING.md) to Gitpay on GitHub or join our team on GitHub first. [Join the Gitpay team on GitHub](https://github.com/worknenjoy/gitpay/) <a href="https://github.com/worknenjoy/gitpay/graphs/contributors"><img src="https://opencollective.com/gitpay/contributors.svg?width=890&button=false" /></a> ## Requirements To contribute to Gitpay, you will need the following: - Node.js (currently at v17.3.0) - React with webpack ## Running Tests To run the tests, use the following commands: `npm run migrate-test` (first time) `npm run test` (to run the tests) ## Setup Environment 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 [email protected]). You can do this with: `cp .env.example .env` #### You need to create the .env in order to run the project: `cp .env.example .env` ### Important - Make sure to use Node v17 (you can use <a href="https://www.freecodecamp.org/news/node-version-manager-nvm-install-guide/"> Node Version Manager (NVM)</a> to manage and switch different Node versions) - Don't forget to run `npm install` on the root and front-end folders ### Database #### Install Postgres (Mac) 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. Log in to 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` #### Install PostgreSQL (Linux - Ubuntu) 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. Log in to 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` #### Install PostgreSQL (Windows) 1. Download: access `https://www.enterprisedb.com/downloads/postgres-postgresql-downloads` and download the `.exe` file for Windows; 2. Install: proceed with the PostgreSQL setup wizard; once it asks for a password for the database superuser, type `postgres`. 3. Log in to 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` ## Run migration 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)` ## Database seeding 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_ ### For windows users: - install cross-env - run `npm run seed:windows` and `npm run seed-test:windows` ## Run project ### Frontend server - first go to `frontend` folder: `cd frontend` - Then run the server: `npm run dev` ### Backend (node.js) `npm run start:dev` Then you can access at http://localhost:8082 ### Activating user account locally 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 ---- [email protected] 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. ## Translation 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 ### Requirements - `Docker Engine` - `Docker Compose` ### **Linux** ### Ubuntu #### Installing - Docker Engine: https://docs.docker.com/install/linux/docker-ce/ubuntu/ - Docker Compose: https://docs.docker.com/compose/install/ ### Arch Linux / Manjaro / Antergos #### Installing - Docker and Docker Compose: `sudo pacman -S docker docker-compose` #### Running ##### Development environment - Run `docker-compose up` Then you can access at http://localhost:8082 ##### Test environment - Run `docker-compose -f docker-compose.test.yml up` ### First timers Here you can start to learn how to create your first pull request and start to be a contributor: [https://github.com/worknenjoy/gitpay/issues/247](https://github.com/worknenjoy/gitpay/issues/247) - [saip007](https://github.com/saip007/) - [Unnatii](https://github.com/unnatii) - [Prerna Verma](https://github.com/PrernaVerma) - [I Gede Wicaksana](https://github.com/wicaker) - [Luísa Barros](https://github.com/luisabfs) - [Caio Reis](https://github.com/caioreis123) - [Shivam Latawa](https://github.com/ShivamLatawa) - [Md. Al Amin](https://github.com/Alamin02) - [Siso](https://github.com/sisohs) - [Amrut](https://github.com/amrut07) - [Usman Sakirat Kehinde](https://github.com/oyinkan) - [Qiwei](https://github.com/qiweiii) - [Adam Ash](https://github.com/adamash99) - [Shawn Noruzi](https://github.com/shawn-noruzi) - [Ssentongo Alex](https://github.com/aleku399) - [Tushar Kudal](https://github.com/tusharkudal) - [Onamade Okikioluwa](https://github.com/khoded) - [Basukinath Tiwari](https://github.com/basuki57) - [Paulo Henrique](https://github.com/henriques4nti4go) ### Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/gitpay/contribute)] #### Individuals <a href="https://opencollective.com/gitpay"><img src="https://opencollective.com/gitpay/individuals.svg?width=890"></a> #### Organizations Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/gitpay/contribute)] <a href="https://opencollective.com/gitpay/organization/0/website"><img src="https://opencollective.com/gitpay/organization/0/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/1/website"><img src="https://opencollective.com/gitpay/organization/1/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/2/website"><img src="https://opencollective.com/gitpay/organization/2/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/3/website"><img src="https://opencollective.com/gitpay/organization/3/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/4/website"><img src="https://opencollective.com/gitpay/organization/4/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/5/website"><img src="https://opencollective.com/gitpay/organization/5/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/6/website"><img src="https://opencollective.com/gitpay/organization/6/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/7/website"><img src="https://opencollective.com/gitpay/organization/7/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/8/website"><img src="https://opencollective.com/gitpay/organization/8/avatar.svg"></a> <a href="https://opencollective.com/gitpay/organization/9/website"><img src="https://opencollective.com/gitpay/organization/9/avatar.svg"></a> ## License [](https://github.com/worknenjoy/gitpay/blob/master/LICENSE.md) This project is licensed under the [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/) license. Please review the license terms and conditions for details. [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fworknenjoy%2Fgitpay?ref=badge_large) 💙 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