Fix issue #6: docs: add README with set up instructions

This PR addresses the changes requested in issue #6

Certainly! I'll create a README.md file with the setup instructions as requested. Here's the SEARCH/REPLACE block to create the new file:

README.md

<<<<<<< SEARCH
=======
# GitHub App for Issue Resolution

This GitHub App automatically creates pull requests to resolve issues and responds to pull request review comments.

## Setup Instructions

Follow these steps to set up and run the GitHub App:

1. **Clone the repository and set up the environment:**

git clone cd python -m venv venv source venv/bin/activate # On Windows, use venv\Scripts\activate pip install -r requirements.txt


2. **Set up a webhook URL with [Smee.io](https://smee.io/):**
   - Visit [Smee.io](https://smee.io/) and click "Start a new channel"
   - Keep this page open, you'll need the webhook URL in the next step

3. **[Set up a new GitHub App](https://docs.github.com/en/apps/creating-github-apps):**
   - Go to your GitHub account settings > Developer settings > GitHub Apps > New GitHub App
   - Fill in the required fields
   - Under 'Webhook', set the webhook URL to the one you created with Smee
   - [Generate a random string](https://www.random.org/strings/?num=10&len=32&digits=on&upperalpha=on&loweralpha=on&unique=on&format=html&rnd=new) and set it as the 'Webhook secret'
   - Under 'Repository permissions', set 'Issues' and 'Pull requests' to 'Read & write'
   - Under 'Subscribe to events', check 'Issues' and 'Pull request review comment'
   - Create the app
   - Under 'Private keys', generate a new private key and download it
   - Store the `.pem` file in the project directory

4. **Set up the environment variables:**
   - Duplicate `.env.sample` to `.env`
   - Replace the placeholder values in `.env`:
     - `GITHUB_WEBHOOK_SECRET`: the 'Webhook secret' string you generated
     - `GITHUB_APP_ID`: App ID at the top of the app settings
     - `GITHUB_PRIVATE_KEY_PATH`: relative path to .pem file (e.g., 'private-key.pem')
     - `GITHUB_APP_USER_NAME`: the 'name' of your GitHub app, followed by '[bot]'

5. **Install the App:**
   - In the left sidebar of the app settings, click 'Install App'
   - Choose the repositories you want to enable it for

6. **Run the application:**
   - Start the Flask development server:

 python main.py
 ```

In a new terminal, start Smee to forward webhook requests:

 npx smee -u <your-smee-webhook-url> -t http://localhost:5000/webhook

Test the App:
- Create a new issue in a repository where the app is installed
- The app should react to the issue with the 'eyes' reaction, then create a PR to resolve the issue
- Check the Flask dev server logs if you encounter any issues

Troubleshooting

If you run into any problems, check the following:

Ensure all environment variables in .env are correctly set
Verify that the webhook URL in the GitHub App settings matches your Smee URL
Check that the Smee client is running and forwarding requests
Review the Flask dev server logs for any error messages

For more detailed information, refer to the GitHub Apps documentation.

REPLACE

This README.md file provides a comprehensive guide for setting up and running the GitHub App. It includes all the steps mentioned in the issue, along with some additional details and a troubleshooting section.

Is there anything else you'd like me to add or modify in the README?

larryhudson / aiderbot

Fix issue #6: docs: add README with set up instructions #7

Troubleshooting