Add API that returns geoJSON for a query

[dhruv-1001]

Description

This issue tracks the implementation of an API that return geoJSON for given query

Implementation Details

1. Define the API

• Task: Design and define the API /getGeoJSON. The API definition needs to be added here - https://github.com/ChakshuGautam/geoip/blob/master/server/spec.yaml
• Details: The API should be capable of accepting location name in query and should be able to perform search on multiple geolocation levels that is <district|state|subdistrct|city|ward> and should return geoJSON based on the search. This can have multiple hits for locations with similar names. There should be additional query parameters to filter out the data accordingly.
• Approval: The API design needs to be reviewed and approved before proceeding with implementation.

2. Implement Server Logic

• Task: Develop the server-side logic to handle the above defined API
• Details: This involves integrating the approved OpenAPI Specification and ensuring the server correctly processes incoming requests and communicates with the geocoding service. The implementation will lie in this file - https://github.com/ChakshuGautam/geoip/blob/master/server/app.js
• Dependence: This step is contingent upon the approval of the API design.

3. Add Tests

• Task: Write unit and integration tests for the reverse geocoding feature.
• Details: Ensure that the feature is thoroughly tested, covering various edge cases and scenarios. Tests will lie here - https://github.com/ChakshuGautam/geoip/blob/master/server/__tests__/sample.test.js

4. Update Documentation

• Task: Update the main README file to include information about the new API
• Details: The documentation should clearly explain how to use the feature, any limitations, and provide examples.

Resources

• GeoJSONs for testing and implementation can be found here.

Expected Outcomes

• A fully functional reverse getGeoJSON API integrated into our server.
• Comprehensive tests ensuring the reliability of the feature.
• Updated documentation for easy use and understanding of the new feature.

Product Name

GeoIP

Project Name

GeoIP

Organization Name

SamagraX

Domain

NA

Tech Skills Needed

Node JS

Category

Feature

Mentor(s)

@ChakshuGautam

Complexity

Low

[Sohelhere]

I am interested in this ✋ project but the thing is this is first time I am going to contribute could you plz guide me..