Skip to content

Commit 85133e7

Browse files
authoredOct 10, 2024
Merge pull request #16 from Deborah-Digges/patch-1
[Dev Setup] Add more detailed instructions to dev setup
2 parents ce7ca66 + 8b09d0b commit 85133e7

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed
 

‎README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,35 @@ You can ask it things like "what models are available?" or "which model should I
1717

1818
## Development
1919

20-
Install dependencies:
20+
1. Install dependencies:
2121

2222
```bash
2323
npm install
2424
```
2525

26-
To run in development mode:
26+
2. Run the server
27+
28+
- To run in development mode:
2729

2830
```bash
2931
npm run dev
3032
```
3133

32-
To build and run in production mode:
34+
- To build and run in production mode:
3335

3436
```bash
3537
npm run build && npm start
3638
```
39+
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
40+
41+
In short, we would expose a public URL for our local server using the following command (follow the guide for detailed setup instructions):
42+
```
43+
ngrok http http://localhost:3000
44+
```
45+
46+
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
47+
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.)
48+
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!
3749

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

0 commit comments

Comments
 (0)
Failed to load comments.