Follow these steps to clone the repository and start the development server:
git clone [email protected]:gibwork/gibwork-github-tips.gitcd gibwork-github-tipsyarn install- Create a
.env.localfile by copying the example environment file: - Add the required environment variables to the
.env.localfile.
To run the project in development mode, use the following command:
yarn dev:user-botyarn build
yarn start:github-appTo run the project in production mode, use the following command:
yarn build
# user-bot
yarn start:user-bot
# github-app
yarn start:github-appThe GitHub API imposes a default rate limit of 5000 requests per hour. If the bot is set to check notifications every 5 seconds (the default delay), it will operate well within this limit. However, setting the delay too short could result in exceeding the rate limit.
If you have suggestions for how gibworkbot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.