@@ -66,24 +66,24 @@ governed by a state machine to ensure code quality through automated reviews, bu
6666
6767### 📦 Setup
6868
69- 1 . Clone the repository:
69+ 1 . #### Clone the repository:
7070 ``` bash
7171 git clone https://github.com/Pantheon-temple/Prometheus.git
7272 cd Prometheus
7373 ```
7474
75- 2 . Copy the ` example.env ` file to ` .env ` and update it with your API keys and other required configurations:
75+ 2 . #### Copy the ` example.env ` file to ` .env ` and update it with your API keys and other required configurations:
7676 ``` bash
7777 mv example.env .env
7878 ```
7979
80- 3 . Create the working directory to store logs and cloned repositories:
80+ 3 . #### Create the working directory to store logs and cloned repositories:
8181
8282 ``` bash
8383 mkdir working_dir
8484 ```
8585
86- 4 . Start the services using Docker Compose:
86+ 4 . #### Start the services using Docker Compose:
8787
8888 - ** Linux (includes PostgreSQL)** :
8989 ``` bash
@@ -100,10 +100,33 @@ governed by a state machine to ensure code quality through automated reviews, bu
100100 docker-compose -f docker-compose.win_mac.yml up --build
101101 ```
102102
103- 5. Access Prometheus:
103+ 5. #### Access Prometheus:
104104 - Service: [http://localhost:9002](http://localhost:9002)
105105 - OpenAPI Docs: [http://localhost:9002/docs](http://localhost:9002/docs)
106106
107+ 6. #### Upload Your Codebase:
108+
109+ You can upload a GitHub repository to Prometheus using the following API endpoint:
110+
111+ - **Endpoint:** `GET /github/`
112+ - **Query Parameter:** `https_url` (the HTTPS URL of your GitHub repository)
113+
114+ **Example using `curl`:**
115+
116+ ```bash
117+ curl -X GET "http://localhost:9002/github/?https_url=https://github.com/your/repo.git"
118+ ```
119+
120+ This will clone the specified repository (defaulting to the latest commit on the main branch) into Prometheus.
121+
122+ 7. #### 📝 Answer Repository Issues
123+
124+ You can ask Prometheus to analyze and answer a specific issue in your codebase using the `/answer/` API endpoint.
125+
126+ - **Endpoint:** `POST /answer/`
127+ - **Request Body:** JSON object matching the `IssueRequest` schema (see [API Documents](http://localhost:9002/docs#/issue/answer_issue_issue_answer__post))
128+ - **Response:** Returns the generated patch, test/build results, and a summary response.
129+
107130---
108131
109132## 🗄️ Database Setup
0 commit comments