/KnowYourCity

Primary LanguageJavaScriptMIT LicenseMIT

Know Your City App

Welcome to the Know Your City App, a React application that allows you to retrieve information about a city based on its PIN code. This application utilizes the Pin component to facilitate the search and display relevant data.

How to Use

  1. Enter PIN Code:

    • Input a 6-digit PIN code in the provided field.
  2. Check City Information:

    • Click the "Check" button to fetch and display information about the city associated with the provided PIN code.
  3. View Data Modal:

    • If the information is available, a modal will open, displaying details about the city, such as post office details.

Repository

Explore the source code on GitHub: Know Your City Repository

Pin Component

The Pin component is responsible for handling the PIN code input, fetching city information, and displaying the results. It includes a modal from the Material-UI library for a user-friendly display.

Know Your City App - Initial Setup

Prerequisites

  • Node.js installed on your machine
  • npm (Node Package Manager) installed

Installation

1. Clone the Repository

 git clone https://github.com/hmadhavan57/Know_Your_City.git

2. Navigate to the Project Directory

  cd Know_Your_City

3. Install Dependencies

 npm install

4. Start the Development Server

  npm start

The app will be running at http://localhost:3000 by default.

5. Open Your Browser

Open your web browser and go to http://localhost:3000 to view the Know Your City App.

Questions or Issues?

If you have any questions or encounter issues, feel free to open an issue on the GitHub repository.

Happy exploring and coding!