Update README.md #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| @@ -10,4 +11,31 @@ The project will consist of developing an open-source API that allows you to pas | |||
| - Octokit.JS | |||
| - Jest | |||
|
|
|||
| ## Dev Runbook | |||
| Dependancies: NodeJS, npm, GithubAPIKey | |||
There was a problem hiding this comment.
Which node version. Add links on how to get a github api key
| 6. Now the nodejs server should be running! To test it just go to `localhost:{{PORT}}` and the text `TypeScript With Express` should be returned. | ||
|
|
||
| ## Setting up ElasticSearch Runbook (Dev/Local) | ||
| -**docker pull docker.elastic.co/elasticsearch/elasticsearch:8.8.2** |
There was a problem hiding this comment.
Create a docker compose file or a bash script with that does all this setup
There was a problem hiding this comment.
Will do added to backlog.
|
|
||
| ## API Endpoints | ||
| [](https://app.getpostman.com/run-collection/19841716-f1801bb7-b189-429b-a875-91b115d349a2?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D19841716-f1801bb7-b189-429b-a875-91b115d349a2%26entityType%3Dcollection%26workspaceId%3D5ebe19fb-61d4-47a7-9cae-de3834853f6b) | ||
| - **/search?prompt={{prompt}}** : The active search endpoint. Add the search prompt in the prompt variable in query params. |
There was a problem hiding this comment.
What method i.e verb? Also given you have a postman collection why is this even required?
There was a problem hiding this comment.
Yup, just wanted to offer an alternative
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.