Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/worknenjoy/gitpay
Bounties for issues on demand. Be rewarded by learning, using Git workflow and continuous integration
https://github.com/worknenjoy/gitpay
bountiesnetwork freelance-work git github issue-management marketplace pull-requests
Last synced: 3 months ago
JSON representation
Bounties for issues on demand. Be rewarded by learning, using Git workflow and continuous integration
- Host: GitHub
- URL: https://github.com/worknenjoy/gitpay
- Owner: worknenjoy
- License: other
- Created: 2017-04-06T08:25:47.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T17:35:43.000Z (7 months ago)
- Last Synced: 2024-04-14T18:52:10.884Z (7 months ago)
- Topics: bountiesnetwork, freelance-work, git, github, issue-management, marketplace, pull-requests
- Language: JavaScript
- Homepage: http://gitpay.me
- Size: 49.3 MB
- Stars: 172
- Watchers: 16
- Forks: 157
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - worknenjoy/gitpay - Bounties for issues on demand. Be rewarded by learning, using Git workflow and continuous integration (JavaScript)
README
[](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 empowers collaboration and rewards contributions to open-source projects.
### Slack channel
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](https://join.slack.com/t/gitpay-workspace/shared_invite/zt-1ru4j0duc-mOPFRxkhRyMgavlGdlghmw)
## What is Gitpay?
Gitpay is an open-source platform that empowers collaboration and rewards contributions to open-source projects. With Gitpay, you can complete tasks from anywhere in the world with open collaboration and receive bounties for completing them. Likewise, companies can receive reports, fixes, and enhancements from developers and offer bounties for completing requirements.
## 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/)
## Requirements
To contribute to Gitpay, you will need the following:
* Node.js (currently at v8.6.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 run create the .env in order to run the project: `cp .env.example .env`
### Important
- Make sure to use Node v12 (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
### 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. Login into the Postgres cli with 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. Login into the Postgres cli with 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 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`
## 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:
- Go to line 42 in the `migrate.js` file and hardcode "seed" into the env var below:
`const migrationType = process.env.TYPE`
- So it will be:
`const migrationType = "seed"`
- Then run the commands above
## 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 setup 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: '
Hi Contrib7,
Click here to activate your account.
\n' +
' \n' +
'\n' +
'\n' +
'Thanks,
\n' +
'Gitpay Team\n' +
'
\n' +
'----------------------\n' +
'\n' +
'\n' +
'https://gitpay.me (Web)
\n' +
'[email protected] (Email)
\n' +
'Worknenjoy Inc.,\n' +
'9450 SW Gemini Dr\n' +
'PMB 72684\n' +
'Beaverton, Oregon 97008-7105 US (Mail)
\n' +
'
\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
#### 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)]
## License
[](https://github.com/your/repository/blob/main/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)