Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added Home Page #131

Closed
wants to merge 118 commits into from
Closed

Conversation

JiyaGupta-cs
Copy link

@JiyaGupta-cs JiyaGupta-cs commented Mar 2, 2024

Closes #57
I have opened a Draft PR
Please provide your further suggestions to improve it
I am further working to make it Mobile responsive and adding Github Readme Link
@Mr-Sunglasses

@Mr-Sunglasses
Copy link
Contributor

@JiyaGupta-cs Could you share some screen shots of the homepage here ?

@JiyaGupta-cs
Copy link
Author

image
@Mr-Sunglasses

@Mr-Sunglasses
Copy link
Contributor

image @Mr-Sunglasses

LGTM, cc. @ChakshuGautam

@JiyaGupta-cs
Copy link
Author

Description-

I have added Github Readme Link as required in the issue
Also Made Responsive for Phone View

Laptop View-

localhost_3000_

Phone View-

localhost_3000_(iPhone SE)

@Mr-Sunglasses
Copy link
Contributor

@JiyaGupta-cs Open-API specs](https://github.com/ChakshuGautam/geoquery.in/blob/master/server/spec.yaml) We can list down this API's on our website.

You can use Swagger Editor to render openapi specs

@JiyaGupta-cs
Copy link
Author

@Mr-Sunglasses Should I replace the core value cards already present on the website with the API names or should make a new other section for it?

@Mr-Sunglasses
Copy link
Contributor

@Mr-Sunglasses Should I replace the core value cards already present on the website with the API names or should make a new other section for it?

It's better to have a newer section.

@JiyaGupta-cs
Copy link
Author

JiyaGupta-cs commented Mar 2, 2024

Summary: Get GeoLocation in JSON
Method: GET
Path: /city/{ip}
Parameters:
ip (path): IP address (required)
fields (query): Comma-separated list of fields to include in response (optional)
lang (query): Language code (optional)
callback (query): Callback function name for JSONP response (optional)
Response: Successful response in JSON format
Get GeoLocation in XML

Summary: Get GeoLocation in XML
Method: GET
Path: /city/xml/{ip}
Parameters:
ip (path): IP address (required)
fields (query): Custom fields (optional)
lang (query): Response language (optional)
Response: Successful response in XML format
Get GeoLocation in CSV

Summary: Get GeoLocation in CSV
Method: GET
Path: /city/csv/{ip}
Parameters:
ip (path): IP address (required)
fields (query): Custom fields (optional)
lang (query): Response language (optional)
header (query): Include field header (optional)
Response: Successful response in CSV format
Get GeoLocation in NewLine

Summary: Get GeoLocation in NewLine
Method: GET
Path: /city/line/{ip}
Parameters:
ip (path): IP address (required)
fields (query): Custom fields (optional)
lang (query): Response language (optional)
Response: Successful response in Line format
Get GeoLocation for a batch of IPs

Summary: Get GeoLocation for a batch of IPs
Method: POST
Path: /batch
Parameters:
fields (query): Comma-separated list of fields to include in response (optional)
lang (query): Language code (optional)
Request Body: Batch request body (required)
Response: Successful response in JSON format
Get DNS and EDNS Info

Summary: Get DNS and EDNS Info
Method: GET
Path: /dns
Parameters:
callback (query): Callback function name for JSONP response (optional)
Response: Successful response in JSON format
Converts geographic coordinates into a human-readable address or place name

Description: Converts geographic coordinates into a human-readable address or place name
Method: GET
Path: /georev
Parameters:
lat (query): Latitude for reverse geocoding
lon (query): Longitude for reverse geocoding
Response: Successful response in JSON format
Return polygon centroid coordinates for given query from sub-district, district, or state level

Description: Return polygon centroid coordinates for given query from sub-district, district, or state level
Method: GET
Path: /location/{locationlevel}/centroid
Parameters:
locationlevel (path): Location level (sub-district, district, or state)
query (query): Query string
Response: Successful response in JSON format

  1. Have I extracted right?
  2. Do I need to right all the parameters in the cards
  3. Moreover in the meet it was said 5 APIs , but it is giving more
    @Mr-Sunglasses

@JiyaGupta-cs
Copy link
Author

And can you please also add C4GT Community label to it @Mr-Sunglasses , so that I can get my points to enter C4GT LeaderBoard

@JiyaGupta-cs
Copy link
Author

@ChakshuGautam ?

@Mr-Sunglasses Mr-Sunglasses added dev sprints an event where open source programmers meet, and work together. dev sprint march Devsprints for march labels Mar 3, 2024
@JiyaGupta-cs
Copy link
Author

Summary: Get GeoLocation in JSON Method: GET Path: /city/{ip} Parameters: ip (path): IP address (required) fields (query): Comma-separated list of fields to include in response (optional) lang (query): Language code (optional) callback (query): Callback function name for JSONP response (optional) Response: Successful response in JSON format Get GeoLocation in XML

Summary: Get GeoLocation in XML Method: GET Path: /city/xml/{ip} Parameters: ip (path): IP address (required) fields (query): Custom fields (optional) lang (query): Response language (optional) Response: Successful response in XML format Get GeoLocation in CSV

Summary: Get GeoLocation in CSV Method: GET Path: /city/csv/{ip} Parameters: ip (path): IP address (required) fields (query): Custom fields (optional) lang (query): Response language (optional) header (query): Include field header (optional) Response: Successful response in CSV format Get GeoLocation in NewLine

Summary: Get GeoLocation in NewLine Method: GET Path: /city/line/{ip} Parameters: ip (path): IP address (required) fields (query): Custom fields (optional) lang (query): Response language (optional) Response: Successful response in Line format Get GeoLocation for a batch of IPs

Summary: Get GeoLocation for a batch of IPs Method: POST Path: /batch Parameters: fields (query): Comma-separated list of fields to include in response (optional) lang (query): Language code (optional) Request Body: Batch request body (required) Response: Successful response in JSON format Get DNS and EDNS Info

Summary: Get DNS and EDNS Info Method: GET Path: /dns Parameters: callback (query): Callback function name for JSONP response (optional) Response: Successful response in JSON format Converts geographic coordinates into a human-readable address or place name

Description: Converts geographic coordinates into a human-readable address or place name Method: GET Path: /georev Parameters: lat (query): Latitude for reverse geocoding lon (query): Longitude for reverse geocoding Response: Successful response in JSON format Return polygon centroid coordinates for given query from sub-district, district, or state level

Description: Return polygon centroid coordinates for given query from sub-district, district, or state level Method: GET Path: /location/{locationlevel}/centroid Parameters: locationlevel (path): Location level (sub-district, district, or state) query (query): Query string Response: Successful response in JSON format

  1. Have I extracted right?
  2. Do I need to right all the parameters in the cards
  3. Moreover in the meet it was said 5 APIs , but it is giving more
    @Mr-Sunglasses

@Mr-Sunglasses Please describe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev sprint march Devsprints for march dev sprints an event where open source programmers meet, and work together.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Home page