https://github.com/0prashantyadav0/github-bot
A github bot to manage organisation using Probot.
https://github.com/0prashantyadav0/github-bot
github-bot issue-assigner probot serverless
Last synced: about 2 months ago
JSON representation
A github bot to manage organisation using Probot.
- Host: GitHub
- URL: https://github.com/0prashantyadav0/github-bot
- Owner: 0PrashantYadav0
- License: isc
- Created: 2025-03-08T16:12:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-08T16:21:54.000Z (over 1 year ago)
- Last Synced: 2025-03-08T17:23:48.266Z (over 1 year ago)
- Topics: github-bot, issue-assigner, probot, serverless
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Github Bot
> A GitHub App built with [Probot](https://github.com/probot/probot) that automates issue management workflows.
## What does this project do?
This project is a GitHub bot designed to streamline issue management workflows. It automates tasks such as assigning issues, labeling, and more, making it easier for maintainers and contributors to manage their projects efficiently.
## Setup
To set up the project locally, follow these steps:
```sh
# 1. Clone the repository
git clone https://github.com/0PrashantYadav0/github-bot.git
# 2. Navigate to the project directory
cd github-bot
# 3. Install dependencies
npm install
# 4. Start the bot
npm start
```
## Database Setup
To start the database using Docker Compose, follow these steps:
```sh
# 1. Ensure Docker and Docker Compose are installed on your machine
# 2. Start the database container
docker-compose up -d
# 3. The database will be available at the URL specified in the docker-compose.yml file
# Update your environment variables to use this database URL
```
## Docker
To run the project using Docker, follow these steps:
```sh
# 1. Build the container
docker build -t github-bot .
# 2. Start the container
docker run -e APP_ID= -e PRIVATE_KEY= -e DATABASE_URL= github-bot
```
## Contributing
We welcome contributions! If you have suggestions for improvements or want to report a bug, please open an issue. Here are the steps to contribute:
1. **Open an Issue**: If you find a bug or have a feature request, open an issue using the provided template.
2. **Get Assigned**: Use the `/assign` command in the issue comments to get assigned to the issue.
3. **Open a Pull Request**: Once you have made your changes, open a pull request for review.
For more details, check out the [Contributing Guide](CONTRIBUTING.md).
## Links
- [Probot](https://github.com/probot/probot)
- [Contributing Guide](CONTRIBUTING.md)
- [Issue Template](.github/ISSUE_TEMPLATE.md)
## License
[ISC](LICENSE) © 2025 JoyBoy