Skip to content

nikhildahake/DeepRunner

Repository files navigation

1. Clone Deeprunner: git clone https://github.com/nikhildahake/DeepRunner.git
2. Install JRE 17
3. After cloning, navigate to: DeepRunner\solr-9.9.0\bin
4. To start solr, use this command: solr start
5. To stop solr, use this command: solr stop --all
6. Now, we will start our application. Navigate to root directory DeepRunner.
7. Run: gradlew bootRun
8. Open Postman and run the following commands:
	
	a) To index a new document: http://localhost:8080/documents (POST)
	Headers: X-Tenant-ID:tenantA
	Body(raw, JSON): {"title": "Software Engineer","content": "Working on backend APIs"}
	
	You will get a response similar to this:
	{
		"id": "11bf01d9-9d2b-47bc-a706-0ce69d902de5",
		"tenantId": "tenantA",
		"title": "Software Engineer",
		"content": "Working on backend APIs",
		"createdAt": "2025-10-12T14:27:17.976852500Z",
		"score": null
	}
	
	b) To fetch the above document using its id: http://localhost:8080/documents/11bf01d9-9d2b-47bc-a706-0ce69d902de5 (GET)
	Headers: X-Tenant-ID:tenantA
	Body: none
	
	You will get a response similar to this:
	{
		"id": "11bf01d9-9d2b-47bc-a706-0ce69d902de5",
		"tenantId": "tenantA",
		"title": "Software Engineer",
		"content": "Working on backend APIs",
		"createdAt": "Sun Oct 12 19:57:17 IST 2025",
		"score": null
	}
	
	c) To search for the above document using a search term, try this: http://localhost:8080/search?q=engineer (GET)
	Headers: X-Tenant-ID:tenantA
	Body: none	
	
	You will get a response similar to this:
	[
		{
			"id": "11bf01d9-9d2b-47bc-a706-0ce69d902de5",
			"tenantId": "tenantA",
			"title": "Software Engineer",
			"content": "Working on backend APIs",
			"createdAt": "Sun Oct 12 19:57:17 IST 2025",
			"score": 3.8267965
		},
		{
			"id": "37fb913d-9cc1-48fd-b7f7-9660f86e1a59",
			"tenantId": "tenantA",
			"title": "Software Engineer",
			"content": "Working on backend APIs",
			"createdAt": "Sun Oct 12 10:30:28 IST 2025",
			"score": 1.4228351
		},
		{
			"id": "844a6ad2-dbcb-43a8-90a2-0ff9a1809e35",
			"tenantId": "tenantA",
			"title": "Software Engineer",
			"content": "Working on backend APIs",
			"createdAt": "Sun Oct 12 11:16:04 IST 2025",
			"score": 1.4228351
		}
	]
	
	d) To delete document: 11bf01d9-9d2b-47bc-a706-0ce69d902de5, try this: http://localhost:8080/documents/11bf01d9-9d2b-47bc-a706-0ce69d902de5 (DELETE)
	Headers:X-Tenant-ID:tenantA
	Body: none
	You will get a "204 No content" response.
	
	e)	To perform health check, try this: http://localhost:8080/actuator/health (GET)
	You will get the following response:
	{
		"status": "UP"
	}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published