Skip to content

Commit

Permalink
Merge pull request #16 from Deborah-Digges/patch-1
Browse files Browse the repository at this point in the history
[Dev Setup] Add more detailed instructions to dev setup
  • Loading branch information
JasonEtco authored Oct 10, 2024
2 parents ce7ca66 + 8b09d0b commit 85133e7
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,35 @@ You can ask it things like "what models are available?" or "which model should I

## Development

Install dependencies:
1. Install dependencies:

```bash
npm install
```

To run in development mode:
2. Run the server

- To run in development mode:

```bash
npm run dev
```

To build and run in production mode:
- To build and run in production mode:

```bash
npm run build && npm start
```
3. Follow [this guide](https://docs.github.com/en/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent#configuring-your-server) to make your server accessible to the internet

In short, we would expose a public URL for our local server using the following command (follow the guide for detailed setup instructions):
```
ngrok http http://localhost:3000
```

4. Follow [this guide](https://docs.github.com/en/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension) to create a GitHub app
5. Follow [this guide](https://docs.github.com/en/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-agent) to configure the app to use the public URL from (3.)
6. Use your newly installed app! On any copilot enabled page, type `@your-app-name <prompt>` (from the app created in 4.) to interact with your local installation of this extension!

## Copilot Extensions Documentation
- [Using Copilot Extensions](https://docs.github.com/en/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat)
Expand Down

0 comments on commit 85133e7

Please sign in to comment.