Ryven Address Picker

A simple, efficient, and optimized address picker solution for selecting countries, states, and cities. Perfect for applications requiring address input with dynamic region-based filtering.

Features

• Get countries, states, and cities for the USA.
• Optimized data structure for quick lookup and minimal memory usage.
• Easy to integrate into JavaScript applications.
• Designed with performance in mind to ensure minimal latency.

Installation

You can install ryven-address-picker via npm:

npm install ryven-address-picker


## Usage

const { getCountries, getStates, getCities } = require('ryven-address-picker');

// Get all countries
console.log(getCountries());  // Output: { USA: { ... } }

// Get all states of the USA
console.log(getStates('USA'));  // Output: { California: { ... }, Texas: { ... }, ... }

// Get cities in California
console.log(getCities('USA', 'California'));  // Output: ['Los Angeles', 'San Francisco', ...]


## Data Structure

{
  "USA": {
    "nationalities": ["American"],
    "states": {
      "California": {
        "cities": ["Los Angeles", "San Francisco", "San Diego"]
      },
      "Texas": {
        "cities": ["Houston", "Dallas", "Austin"]
      }
    }
  }
}

## Code Testing

npm test
Tests are located in the __tests__ directory

## Contributing
We welcome contributions! If you'd like to improve this package, please fork the repository, make your changes, and submit a pull request.

Steps to contribute:
Fork the repo
Create a feature branch
Make your changes
Run tests and ensure everything works
Submit a pull request
License
This project is licensed under the MIT License - see the LICENSE file for details.

Contact
If you have any questions or need further assistance, feel free to open an issue or reach out to the repository maintainer at [email protected]