Skip to content

Commit

Permalink
Fix any typo on the README content - generated by AIPR #1029 (#1030)
Browse files Browse the repository at this point in the history 
* [create-pull-request] automated change

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: GitHub Actions Bot powered by AIPR <[email protected]>
Co-authored-by: Alexandre Magno <[email protected]>
  • Loading branch information
@github-actions @alexanmtz
3 people authored Dec 29, 2023
1 parent 569ca65 commit 556e19a
Showing 1 changed file with 30 additions and 35 deletions.
65 changes: 30 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,43 +9,40 @@ Gitpay is an open-source platform that empowers collaboration and rewards contri

### Slack channel

We have a slack channel to collaborate with solutions and to help you, and to be fun
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)
[Join us on Slack](https://join.slack.com/t/gitpay-workspace/shared_invite/zt-1ru4j0duc-mOPFRxkhRyMgavlGdlghmw)

## What is Gitpay?

We offer a marketplace for contributors and projects that use git for on demand project needs, using the Git Workflow as contract to solve issues and reward contributors.
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.

* You can complete tasks with open collaboration and receive bounties for it
* Companies can receive reports, fixes and enhancements about the project by developers and offer bounties to complete required tasks
## Who is contributing?

## Who is contributing
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/worknenjoy/gitpay/graphs/contributors"><img src="https://opencollective.com/gitpay/contributors.svg?width=890&button=false" /></a>

### Join the team

Join the GitHub team to be assigned to tasks and to be part of the core.
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 v8.6.0)
* React with webpack

## Running Tests

## Running tests
To run the tests, use the following commands:

To run the test:
`npm run migrate-test` (first time)

`npm run test` (to run the tests)

## Setup environment
## Setup Environment

For fully integration with api services used by the platform, you will need the api keys. *You should make a copy of your `.env.example` to `.env`* with the right credentials. Please let me know if you need any of those to solve a issue (mail [email protected])
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`

Expand All @@ -57,25 +54,25 @@ You can do this with: `cp .env.example .env`

### Database

#### Install postgres (mac)
1. install: `brew install postgres`
2. start the service: `brew services start postgresql`
3. create postgres user: `createuser postgres -s`
4. Login into postgres cli: `psql -U postgres`
5. Create test database: `create database gitpay_test;`
6. Create a dev database: `create database gitpay_dev;`
7. Exit: `\q`
#### 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: `sudo apt install postgresql`
2. start the service: `sudo service postgresql start`
3. create postgres user: `createuser postgres -s`
4. Login into postgres: `sudo -i -u postgres`
5. Access the postgres prompt: `psql`
6. 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`
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;
Expand Down Expand Up @@ -224,5 +221,3 @@ Support this project with your organization. Your logo will show up here with a
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.

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fworknenjoy%2Fgitpay.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fworknenjoy%2Fgitpay?ref=badge_large)


0 comments on commit 556e19a

Please sign in to comment.