Skip to content

MustafaM257/states-usa

Repository files navigation

USA States Information Project

Screenshot 2024-07-03 at 2 40 00 PM

Welcome to the USA States Information Project! This project provides comprehensive information about the states of America through an easy-to-use web application. The application consists of three main sections: Home, Zip, and Find.

Live Preview

Check out the live preview of the project here.

Features

  • Home: Browse a list of all states. Click on a state to view detailed information about it.
  • Zip: View a page listing ranges of zip codes.
  • Find: Enter a zip code to find the corresponding city and state.

Technology Stack

This project is built with:

  • Next.js: A React framework for server-side rendering and generating static websites.
  • pnpm: A fast, disk space-efficient package manager.
  • "@tabler/icons-react": "^3.6.0", "clsx": "^2.1.1", "framer-motion": "^11.2.10", "next": "14.2.4", "react": "^18", "react-dom": "^18", "tailwind-merge": "^2.3.0"

Installation and Setup

To run this project locally, you need to have pnpm installed. Follow these steps to get started:

  1. Clone the repository:

    git clone [email protected]:MustafaM257/states-usa.git
    cd states-usa.git
  2. Install dependencies:

    pnpm install
  3. Run the development server:

    pnpm run dev
  4. Open your browser and navigate to:

    http://localhost:3000

Sections

Home

The Home section lists all the states. Clicking on a state will navigate you to a dedicated page with detailed information about that state.

Zip

The Zip section displays a comprehensive list of zip code ranges.

Find

The Find section allows you to enter a zip code and get the corresponding city and state.

Disclaimer

This project is provided free of charge. I am an open-source enthusiast and take no responsibility for the usage of this project. Feel free to contribute and make it better!

Contribution

Contributions are welcome! If you want to contribute to the project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Submit a pull request.

Contact

For any inquiries or feedback, please contact me at:


Feel free to make any adjustments or add more details as needed.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published